marbemac
Joined 14 years ago
Joined 14 years ago
In the "settings" tab for each endpoint, you can mark which security schemes apply to the endpoint. It's kind of hidden, we're moving it to the general definition tab. Also, that info will be exposed in api-docs (which security schemes an endpoint requires/supports) in an update later this week!
From the API Designer (which is private), you can optionally publish any of your API versions out to api-docs.io, for public consumption. You don't even need to publish your entire API definition out - you can mark which endpoints/models are private versus public. Only the parts of your internal docs marked as public will be published out :).
The hosted documentation integration is completely free - we have a paid option coming soon, that adds custom domains, theming, analytics, etc.
Eager to hear what you think - let us know!
They blogged about their experience so far with our tools here: https://sendgrid.com/blog/using-a-prototype-as-an-api-produc...
Prism processes the traffic that passes through it, and generates your spec code from that. It can identify dynamic parameters in the url, build json schemas, etc.
Here's a little post + video we put together: https://medium.com/oh-what-a-wonderful-web/how-to-generate-2...
And another, demonstrating a slightly different process of generating spec code from the Peach mobile app API traffic:
See this issue for more details: https://github.com/Yomguithereal/baobab/pull/74
Basically, you setup test cases for your API(s), and we automatically contract test the inputs/outputs of the requests against your OAS specification where possible. If anything does not validate against the schemas defined in your OAS specification, the test will fail with descriptive errors. If your OAS is ever updated, those changes will automatically work in the tests, since the tests are just referencing the OAS spec (not duplicating data from it).
A couple more things:
- You can create these tests with our visual UI, or write the underlying JSON that describes the tests by hand.
- You can run the tests inside of our UI, or install Prism (our command line runner) to run them completely outside of Stoplight (CI, terminal, etc).
- We plan to support OAS3 later in Q4 of this year.
We live and breathe API tooling and specifications. If you have any questions about process, our product, API strategy, etc, happy to chat - just shoot me an email at marc [at] stoplight.io!