Couchbase incorporated Swagger into our documentation a few months ago. “Swagger” refers to an ecosystem of tools and other resources for managing REST APIs.

Core to Swagger is the Swagger specification. (The group behind Swagger donated the spec to the OpenAPI Initiative. The original site, swagger.io remains the main site for tools and such.)

Once you have the API spec defined for your endpoints, you get several valuable capabilities. My two favorite are the “live” embeddable documentation and the client libraries. Take a look at this short video for a demonstration of some of the features of Swagger.

For an example of using a Swagger JavaScript client, take a look at this blog post.

You can find the Swagger specs for the Sync Gateway public API here and the admin API here.

Here are the Sync Gateway configurations I refer to in the video. The first has the CORS configuration to allow access from swagger.io.

{
  "log": ["*"],
  "CORS": {
     "Origin":["*"],
     "Headers": ["Content-Type"]
  },
  "databases": {
    "db": {
      "server": "walrus:",
      "users": { "GUEST": { "disabled": false, "admin_channels": ["*"] } },
      "allow_empty_password": true
    }
  }
}

The second is for trying out calls through our live documentation.

{
   "log": [
      "*"
   ],
   "SSLCert": "cert.pem",
   "SSLKey": "privkey.pem",
   "CORS": {
      "Origin": ["*"],
      "Headers": ["Content-Type"]
   },
   "databases": {
      "db": {
         "server": "walrus:",
         "users": {
            "GUEST": {
               "disabled":false,
               "admin_channels": [
                  "*"
               ]
            }
         }
      }
   }
}

(Note: There’s currently a known issue with making the calls from the Couchbase documentation. Couchbase now requires access via https, in keeping with security best practices. This means the documentation also redirects using https. This means you have to set up Sync Gateway to use SSL. See the documentation here for more information.)

Postscript

Download Couchbase and Sync Gateway here. See our documentation for how to add Couchbase Lite to a project.

Check out more resources on our developer portal and follow us on Twitter @CouchbaseDev.