Skip to content
This repository has been archived by the owner on Mar 15, 2022. It is now read-only.

Use the GSA API documentation template #824

Open
gbinal opened this issue Nov 28, 2017 · 0 comments
Open

Use the GSA API documentation template #824

gbinal opened this issue Nov 28, 2017 · 0 comments

Comments

@gbinal
Copy link
Member

gbinal commented Nov 28, 2017

An increasing number of GSA APIs are normalizing around the user of this opensource API template.

It'd be very easy to stand up an new instance for the CKAN API and use it for the API docs (I'm happy to take a crack at it and bounce it off you for 👍 ). And adopting this not only makes for good looking api docs, but also helps the agency put forward a more consistent, developer-friendly experience.

The other advantages of it are that it's:

  • Easy for us to update the CKAN API documentation by embedding the api.data.gov key signup form.
  • Easy to add a more developer-friendly experience by linking directly to and describing the data.gov CKAN API's endpoints instead of making the user cross-reference the CKAN API docs with the data.gov endpoint.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant