Search Results
| Search type | Search syntax |
|---|---|
| Tags | [tag] |
| Exact | "words here" |
| Author |
user:1234 user:me (yours) |
| Score |
score:3 (3+) score:0 (none) |
| Answers |
answers:3 (3+) answers:0 (none) isaccepted:yes hasaccepted:no inquestion:1234 |
| Views | views:250 |
| Code | code:"if (foo != bar)" |
| Sections |
title:apples body:"apples oranges" |
| URL | url:"*.example.com" |
| Saves | in:saves |
| Status |
closed:yes duplicate:no migrated:no wiki:no |
| Types |
is:question is:answer |
| Exclude |
-[tag] -apples |
| For more details on advanced search visit our help page | |
Results tagged with api
Search options answers only
not deleted
user 4
An application programming interface (API) is the specification for which software is meant to be used by other software.
0
votes
Should Product Requirements reflect vendors' APIs capabilities and limitations?
If certain functionality is not available, that would cause you to remove the requirement from the system under design, either in general or in the case of an integration with a particular API. …
- 86k
4
votes
Creating a webservice API - how much "credit" should I give the client/developer
You should program defensively - someone will try to use your API in a manner that you don't expect. …
- 86k
12
votes
What should be the http status code for "Service not available in your area" error?
A few make sense.
403 Forbidden, for the reasons that Eric Stein mentions in his answer. You can use various information provided by the request to determine where the client is and who the client is …
- 86k
12
votes
Why must API keys be kept private?
It depends on what the API key does. … I give you an API key based on an agreed upon level of service (perhaps API calls per unit of time). …
- 86k
5
votes
Is it bad practice to create a resource in a GET request when the resource will be created l...
The strongest argument would be that it violates HTTP Semantics.
GET is a safe method, and safe methods are "essentially read-only". That doesn't mean that there can't be side-effects. Two examples ar …
- 86k
4
votes
How do I write user stories for system internal requirements?
Simply saying "provide an API for partner apps" or "make the APIs flexible and rich enough" aren't good requirements, from a traditional or agile perspective. … Once you know what things you want to expose behind an API, you can start to refine and decompose. …
- 86k
61
votes
Accepted
How should source code unit tests affect semantic versioning?
Your unit tests are not part of your public API. By definition, the API is a software interface that allows two or more systems, applications, programs, or components to communicate. … Your public API and its functionality is what it is, regardless of the state of the tests. That functionality also includes defects or deviations that your tests may catch. …
- 86k
23
votes
Accepted
What is the best way to comment a deprecated class in Java?
The recommended approach to deprecating a class, method, or field in Java is to use the @Deprecated annotation, which became available in Java 5, or the @deprecated JavaDoc tag, which has been around …
- 86k
4
votes
How to keep OpenAPI specification up-to-date and compliant without using code generators?
By making sure you can generate your documentation, ideally as part of your build processes, you can reduce or eliminate the problem of the lack of API documentation slowing down the development process …
- 86k
0
votes
What's the proper response when I try to update an existing entity but with not found parent ID
I believe a 200 OK with a response that contains an error code, and ideally an error message, is more suitable than an HTTP error code.
The client has issued a request to entity/{id}, which exists. If …
- 86k
3
votes
UML Use Case Diagram: Should different external APIs be modeled as separate actors?
If you represent them on a UML Use Case Diagram, then each external service would be a separate actor. In UML, an Actor represents "a role played by a user or any other system that interacts" with the …
- 86k