Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Verify proposed endpoints match API Standards #39

Open
Ryandaydev opened this issue Mar 1, 2018 · 3 comments
Open

Verify proposed endpoints match API Standards #39

Ryandaydev opened this issue Mar 1, 2018 · 3 comments

Comments

@Ryandaydev
Copy link

@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
Copy link
Author

Ryandaydev commented Oct 5, 2018

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
Copy link
Author

Ryandaydev commented Oct 30, 2018

Others to add:

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

@Ryandaydev
Copy link
Author

Ryandaydev commented Nov 19, 2018

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant