Swagger on ReadMe
Magically Build Docs While You Write Your Code
Don't have a Swagger file?
# First, install our `oas` moduleAlready have a Swagger file? Upload via a URL
npm install oas -g
# Just type `oas docs` to get started!
What Is Swagger?
It's a format used to document APIs. A simple yet powerful representation of your RESTful API. With the largest ecosystem of API tooling on the planet. Swagger is good stuff.
It's great because you can keep your documentation right in the code! You can document your API while you’re editing code, and then we’ll magically build docs from it.
Already have a Swagger file?
Try it out.
Our Recommended Workflow
Install our `oas` (Open API Spec) command line tool and get started
$ npm install oas -g
$ oas init
Document your API in the comments
* @api [GET] /test/:hi
Upload your Swagger file to ReadMe!
$ oas docs
Add that URL to ReadMe! We'll keep it synced.
All plans have a 14-day free trial before launch. No credit cards until your site is ready to go!Get Started