Improving the API endpoints
$begingroup$
I have been developing an API for my product for the first time. I am bit confused whether the way I have designed the endpoints are correct or not.
For example, I have a POST endpoint when updates a record when called and it is like so.
/testRunResults/status/{projectID}/{testRunID}/{resultID}/{status}
In the code, I take all the required parameters and update the record accordingly. Another way might be
/testRunResults/status/
and appending ?project=1&testid=45&resultid=123&status=passed to the endpoint.
Out of these which is the best option and why?
comparative-review api laravel
asked 5 mins ago
RehanRehan
1
New contributor
Rehan is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
$endgroup$
add a comment |
$begingroup$
I have been developing an API for my product for the first time. I am bit confused whether the way I have designed the endpoints are correct or not.
For example, I have a POST endpoint when updates a record when called and it is like so.
/testRunResults/status/{projectID}/{testRunID}/{resultID}/{status}
In the code, I take all the required parameters and update the record accordingly. Another way might be
/testRunResults/status/
and appending ?project=1&testid=45&resultid=123&status=passed to the endpoint.
Out of these which is the best option and why?
comparative-review api laravel
asked 5 mins ago
RehanRehan
1
New contributor
Rehan is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
$endgroup$
add a comment |
$begingroup$
I have been developing an API for my product for the first time. I am bit confused whether the way I have designed the endpoints are correct or not.
For example, I have a POST endpoint when updates a record when called and it is like so.
/testRunResults/status/{projectID}/{testRunID}/{resultID}/{status}
In the code, I take all the required parameters and update the record accordingly. Another way might be
/testRunResults/status/
and appending ?project=1&testid=45&resultid=123&status=passed to the endpoint.
Out of these which is the best option and why?
comparative-review api laravel
asked 5 mins ago
RehanRehan
1
New contributor
Rehan is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
$endgroup$
I have been developing an API for my product for the first time. I am bit confused whether the way I have designed the endpoints are correct or not.
For example, I have a POST endpoint when updates a record when called and it is like so.
/testRunResults/status/{projectID}/{testRunID}/{resultID}/{status}
In the code, I take all the required parameters and update the record accordingly. Another way might be
/testRunResults/status/
and appending ?project=1&testid=45&resultid=123&status=passed to the endpoint.
Out of these which is the best option and why?
comparative-review api laravel
comparative-review api laravel
asked 5 mins ago
RehanRehan
1
New contributor
Rehan is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
asked 5 mins ago
RehanRehan
1
New contributor
Rehan is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
asked 5 mins ago
RehanRehan
1
New contributor
Rehan is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
asked 5 mins ago
RehanRehan
1
asked 5 mins ago
RehanRehan
1
1
New contributor
Rehan is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
New contributor
Rehan is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
Rehan is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.
add a comment |
add a comment |
0
active
oldest
votes
Your Answer
StackExchange.ifUsing("editor", function () {
return StackExchange.using("mathjaxEditing", function () {
StackExchange.MarkdownEditor.creationCallbacks.add(function (editor, postfix) {
StackExchange.mathjaxEditing.prepareWmdForMathJax(editor, postfix, [["\$", "\$"]]);
});
});
}, "mathjax-editing");
StackExchange.ifUsing("editor", function () {
StackExchange.using("externalEditor", function () {
StackExchange.using("snippets", function () {
StackExchange.snippets.init();
});
});
}, "code-snippets");
StackExchange.ready(function() {
var channelOptions = {
tags: "".split(" "),
id: "196"
};
initTagRenderer("".split(" "), "".split(" "), channelOptions);
StackExchange.using("externalEditor", function() {
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled) {
StackExchange.using("snippets", function() {
createEditor();
});
}
else {
createEditor();
}
});
function createEditor() {
StackExchange.prepareEditor({
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: false,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: null,
bindNavPrevention: true,
postfix: "",
imageUploader: {
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
},
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
});
}
});
Rehan is a new contributor. Be nice, and check out our Code of Conduct.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f212193%2fimproving-the-api-endpoints%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
0
active
oldest
votes
0
active
oldest
votes
active
oldest
votes
active
oldest
votes
Rehan is a new contributor. Be nice, and check out our Code of Conduct.
Rehan is a new contributor. Be nice, and check out our Code of Conduct.
Rehan is a new contributor. Be nice, and check out our Code of Conduct.
Rehan is a new contributor. Be nice, and check out our Code of Conduct.
Thanks for contributing an answer to Code Review Stack Exchange!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
Use MathJax to format equations. MathJax reference.
To learn more, see our tips on writing great answers.
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fcodereview.stackexchange.com%2fquestions%2f212193%2fimproving-the-api-endpoints%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Sign up or log in
StackExchange.ready(function () {
StackExchange.helpers.onClickDraftSave('#login-link');
});
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
