Skip to content

Latest commit

 

History

History
23 lines (13 loc) · 692 Bytes

README.md

File metadata and controls

23 lines (13 loc) · 692 Bytes

Hypatos Studio API docs

The Hypatos REST API is documented using OpenAPI standard and served as a GitHub page. See the API docs.

Contributing changes

If you made any changes to the API descriptions, please check locally how the generated documentation looks like before committing the changes. If you are using it for the first time, please install all dependencies by executing:

npm install

Then start the application

node index.js

and you will see the URL in the terminal like this one. Open the URL and the browser and enjoy!

See the docs at http://localhost:3000/docs/local.html