Swagger on ReadMe

Magically Build Docs While You Write Your Code

Preview your Swagger file

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.

Don't have a Swagger file?

  1. Step 1

    Install our `oas` (Open API Spec) command line tool and get started

    $ npm install oas -g
    $ oas init

  2. Step 2

    Document your API in the comments

    /*
     * @api [GET] /test/:hi
     */
    function() {
    ...

  3. Step 3

    Upload your Swagger file to ReadMe!

    $ oas docs

  4. Step 4

    Add that URL to ReadMe! We'll keep it synced.

     

Try Readme

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

Get Started