Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 

PhyloPic API Documentation

This project is for documenting the planned Application Programming Interface for the next version of PhyloPic. The primary file is openapi.yaml, which is written using the OpenAPI Specification.

View online

An HTML version of the documentation is currently being hosted here.

Getting started

Prerequisites

To do development work, you will likely require yarn. Installation instructions are here.

Installing dependencies

Once yarn is installed, go to the project folder and run:

yarn

Running the tests

To test that openapi.yaml is valid, run:

yarn test

Generating documentation

To generate documentation as an HTML web page, run:

yarn build

This will create files in dist/api/docs/2.0/. To view the document, simply open index.html from that folder in a web browser.

Authors

License

This project is licensed under the CC0 License.

About

Documentation for the PhyloPic 2.0 API

Resources

License

Releases

No releases published

Packages

No packages published