Swagger on ReadMe

Magically Build Docs While You Write Your Code

Don't have a Swagger file?

# First, install our `oas` module
npm install oas -g
# Just type `oas docs` to get started!
oas docs
Already have a Swagger file? Upload via a URL

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.

Why Swagger?

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.

It's Automatic.

 

 Already have a Swagger file?

Try it out.

Try Readme

All plans have a 14-day free trial before launch. No credit cards until your site is ready to go!

Get Started