mycel-openapi

OpenAPI contract for Mycel's REST API.

This repository is automatically updated on every Mycel release and tagged accordingly, allowing implementations to track exactly which version of the contract they target.

Usage

Add as a submodule

git submodule add https://github.com/mycel-project/mycel-openapi test/fixtures/openapi

Pin to a specific Mycel version

cd test/fixtures/openapi
git checkout v0.2.0-alpha
cd ../..
git add test/fixtures/openapi
git commit -m "chore: pin openapi contract to v0.2.0-alpha"

Use the contract

Depending on your language and needs, there are several ways to use the contract:

• Validate requests and responses — parse openapi.json directly and use a schema validation library to ensure your implementation matches the contract. Most languages have OpenAPI-aware libraries for this.
• Mock a Mycel server — Prism can spin up a mock server from the contract, returning valid responses without running a real Mycel instance:

npx @stoplight/prism-cli mock openapi.json

Your implementation can then point to http://localhost:4010 during testing.