api-standards
api-standards copied to clipboard
Verify proposed endpoints match API Standards
@gbinal I think it would be good to make sure the proposed endpoints in the endpoint design follow the URL path in the API standards. It seems to me that the "systems" in the proposed path doesn't match our standard of using {business_function}/{application_name}/{version}/{plural_noun}
Proposed checklist might be:
- [ ] Endpoint uses standard endpoint design.
- [ ] Supports versioning.
- [ ] OpenAPI spec provided.
- [ ] Feedback mechanism clear and monitored.
- [ ] API documentation follows template/standards.
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.