Introducing Stoplight Platform, built from the ground up to work with your Git repos and workflows. Read the announcement
Design Quality APIs 10x Faster
At the beginning of October, the Stoplight team hosted a webinar covering Stoplight Studio, the latest generation of our OpenAPI GUI designer. If you haven’t already, you can watch it here.
Some attendee questions were answered live, but time ran too short to answer everything. Here are some answers to your questions that we weren’t able to cover live.
You sent in feedback that Prism v2 was a bit confusing. With help and input from Prism users, we’ve stripped it back and are planning out features.
The Proxy Server should hopefully solve most of the contract testing needs: https://github.com/stoplightio/prism/issues/473
And figuring out how custom middlewares can be enabled should also solve many customization needs: https://github.com/stoplightio/prism/issues/435
As for other more general testing, there are tools designed for that sort of thing, which are pretty great, like Strest. https://github.com/eykrehbein/strest
Absolutely! At the time of publishing this piece, it’s a planned item on our roadmap. Click here to vote for it. More votes = higher priority for our product team. Keep an eye on our roadmap and change log to stay informed on features as they’re released.
There are quite a few floating around, check out OpenAPI.Tools https://openapi.tools/#sdk
There are a few ways you can go about this. One is to implement tooling which double-checks your docs, things like Dredd can help: https://apisyouwonthate.com/blog/keeping-documentation-honest
This is less popular these days, and many folks just use their API Descriptions for contract testing responses: https://apisyouwonthate.com/blog/writing-documentation-via-contract-testing
You can also use your descriptions as server-side validation: https://www.apisyouwonthate.com/blog/server-side-validation-with-api-descriptions/
The API Reference Documentation is automatically built from your API description documents, so you just write OpenAPI v2/v3 in YAML or JSON, and when you publish, you’ll have docs.
The demo was showing off the markdown articles, which can have code samples and embed Try it Now, but those are more for showing off workflows or more tailored Guides.
Check it out: https://stoplight.io/docs/
Stand-alone Studio is free, forever! Our paid Platform incorporates Studio with other tools, and unlocks the collaboration and governance that companies typically need. That being said, if the free Studio designer plan meets your company’s needs, you’re welcome to use it.
Still have questions? We’re here to help!