Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eai04191/resonite-api-spec
WIP | Resonite OpenAPI specification
https://github.com/eai04191/resonite-api-spec
openapi-specification resonite resonite-api
Last synced: 2 months ago
JSON representation
WIP | Resonite OpenAPI specification
- Host: GitHub
- URL: https://github.com/eai04191/resonite-api-spec
- Owner: eai04191
- License: mit
- Created: 2023-11-29T18:51:28.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-28T12:08:03.000Z (11 months ago)
- Last Synced: 2024-10-01T06:44:44.225Z (3 months ago)
- Topics: openapi-specification, resonite, resonite-api
- Language: HTML
- Homepage: https://elements-demo.stoplight.io/?spec=https://eai04191.github.io/resonite-api-spec/openapi.yml#/
- Size: 216 KB
- Stars: 6
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🧿 Unofficial Resonite API Documentation
Unofficial community-driven OpenAPI specification for [Resonite](https://resonite.com/) API.
## Preview in development
Start a local server to preview the documentation using [Stoplight Elements](https://docs.stoplight.io/docs/elements/d6a8ba3f3c186-stoplight-elements). This server does a live-reload when you make changes to yaml files. Sweet!
```
npm run start
```The local proxy starts on port 8010 and Stoplight Elements starts on port 8081. A local proxy is required to avoid CORS errors and send requests from Stoplight Elements.
## License
This project is licensed under the [MIT License](LICENSE).