README.md

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.

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

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

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

yarn test

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

This project is licensed under the CC0 License.