Skip to content

Latest commit

 

History

History
35 lines (20 loc) · 1.03 KB

README.md

File metadata and controls

35 lines (20 loc) · 1.03 KB

PhyloPic API Documentation

This project is for documenting the API (Application Programming Interface) for PhyloPic. The primary file is public/2.0/openapi.yaml, which is written using the OpenAPI Specification.

View online

The documentation is hosted online here: http://api-docs.phylopic.org

Getting started

See instructions in the PhyloPic project README for setting up the monorepo project.

Testing

To test that public/2.0/openapi.yaml is valid, run:

yarn test

Deploying

To deploy to api-docs.phylopic.org, you will need to install AWS Command Line Interface and set it up with proper credentials.

yarn deploy

Authors

License

This project is licensed under the CC0 License.