api-standards icon indicating copy to clipboard operation
api-standards copied to clipboard

Verify proposed endpoints match API Standards

Open Ryandaydev opened this issue 6 years ago • 3 comments

@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}

Ryandaydev avatar Mar 01 '18 15:03 Ryandaydev

Proposed checklist might be:

  • [ ] Endpoint uses standard endpoint design.
  • [ ] Supports versioning.
  • [ ] OpenAPI spec provided.
  • [ ] Feedback mechanism clear and monitored.
  • [ ] API documentation follows template/standards.

Ryandaydev avatar Oct 05 '18 18:10 Ryandaydev

Others to add:

  • [ ] Using api.gsa.gov for analytics and key management.
  • [ ] Enforces HTTPS

Ryandaydev avatar Oct 30 '18 15:10 Ryandaydev

This will be addressed in the Mandatory Items section of the API Standards.

Ryandaydev avatar Nov 19 '18 15:11 Ryandaydev