Ryan Day
Ryan Day
Proposed checklist might be: - [ ] Endpoint uses standard endpoint design. - [ ] Supports versioning. - [ ] OpenAPI spec provided. - [ ] Feedback mechanism clear and...
Others to add: - [ ] Using api.gsa.gov for analytics and key management. - [ ] Enforces HTTPS
This will be addressed in the Mandatory Items section of the API Standards.
I suggest this could be added now to the "future topics" section of the standards. @JJediny Take a look at the future topics and suggest the wording to be added....
Would be good to create a blank template for this that teams could clone and add to the repo for each technology. Sample template might be something like: | Standards...
Good mention, @JJediny We have reviewed this previously but haven't pursued it further. In essence, GSA as an agency would publish and maintain an apis.json file to publicize our resources....
Good idea, Mark. I have also heard the term "breaking changes" used in regard to major changes. So consumers can trust that until the version changes, they are not required...
For SOAP/XML web services, this document has some good guidance: [Best practices for Web services versioning](https://www.ibm.com/developerworks/webservices/library/ws-version/) Highlights: ### Backwards Compatible Changes * Addition of new WSDL operations to an existing...
@jfredrickson5 who do we talk to about this?
Others: "openapi spec" "SOAP" "interactive documentation"