api-standards
api-standards copied to clipboard
GSA
API Standards for GSA
What are the best practices for: - Providing a test environment to users for your API - Test data - Test credentials Discuss....
Make sure existing API documentation points back to https://open.gsa.gov/api or a redirect that works back to that.
Per the GSA [API Standards](https://github.com/GSA/api-standards#add-your-api-to-the-gsa-api-directory), we have an important responsibility to ensure that our APIs are readily discoverable by those who might use them. Two important steps for this are...
We should periodically review the [API entries that GSA has in data.gov](https://catalog.data.gov/dataset?q=organization%3A%28%28gsa-gov%29+OR+%28opi-gsa-gov%29+OR+%28ocfo-gsa-gov%29+OR+%28ocsit-gsa-gov%29+OR+%28pbs-gsa-gov%29+OR+%28cpo-gsa-gov%29+OR+%28fas-gsa-gov%29+OR+%28ogp-gsa-gov%29+OR+%28gsa-gov1%29%29&res_format=API) to check for any outdated entries. This is in addition to making sure to [add new APIs](https://github.com/GSA/api-standards/issues/35). *...
It looks like you have quite a few Help Wanted issues in your repo. You can feature these on Code.gov and reach a larger audience by adding specific tags to...
Per the GSA [API Standards](https://github.com/GSA/api-standards#provide-documentation), we have [an API Documentation Template](https://github.com/GSA/api-documentation-template). It's open source, functional, easy to clone, developer friendly, and includes a useful public feedback mechanism for users of...
API Standards should explain the process of navigating security for a new system with APIs or a new API to an existing system. Could involve: - Security standards - Workflows...
Add guidance for methods that can be used to mark an API as a prototype, non-production API. A few methods we have implemented with the City Pairs Prototype: - API...
It would be helpful for consumers of these standards to have documented examples of api versioning. For example, what is considered a minor change, major change, etc. Good examples of...
As teams implement these standards on specific technology stacks, they can contribute back to the rest of the organization by demonstrating what type of coding or configuration was necessary. They...