issues
search
NIAID-Data-Ecosystem
/
nde-crawlers
Harvesting infrastructure to collect and standardize dataset and computational tool metadata
Apache License 2.0
0
stars
0
forks
source link
Create API documentation website
#13
Closed
flaneuse
closed
2 years ago
flaneuse
commented
2 years ago
Create an
Open API specification
to describe the functionality of the
NIAID Data Ecosystem Metadata API
Use the
NIAID Data Ecosystem Design library
to create a website to allow users to understand how the API can be used, potentially using
Swagger UI
and/or
SmartAPI
to help create the documentation.
Example for inspiration:
https://mygene.info/v3/api#/query/get_query
Host at api-staging.data.niaid.nih.gov, and eventually at api.data.niaid.nih.gov
(if needed) Work with NIAID OCGR to get approval for site content.
Develop a set of tests / protocol for ensuring that the documentation site is up-to-date with any changes to the API.