couchbaselabs/cb-swagger

Build Couchbase REST API documentation from OpenAPI

Couchbase Swagger Project

This project uses the swagger2markup-gradle-plugin to convert the Swagger specifications for Couchbase REST APIs into AsciiDoctor documentation.

Usage guide

This repository handles several Swagger subprojects. Each subproject is stored in its own subfolder within the src folder.

Build Script

Within each subproject there is a gradle build script with a .gradle extension. The gradle build script specifies the locations of the Swagger source file, any additional AsciiDoc content, and the output AsciiDoc files.

The build.gradle script in the root project folder calls the gradle build scripts from each subproject.

Some subprojects are not currently ready to be built. These do not have a gradle build script.

Swagger Specification

Within each subproject, the Swagger Specification (JSON or YAML) is stored in a folder called swagger. (For some subprojects, the Swagger specification file may be stored remotely, i.e. alongside the development source files.)

AsciiDoc Content

For each subproject, additional AsciiDoc content may be stored in the folder asciidoc/extensions and its subfolders.

Convert a single subproject

./gradlew project:convertSwagger2markup --rerun-tasks

Where project is the subproject that you want to convert, for example, admin.

Convert all projects

./gradlew --rerun-tasks

Acknowledgements

This project is based on the Swagger2Markup Gradle template project.

cb-swagger's Issues

How to use project

Hi,
I just came across your project while researching Swagger in DITA. I work on a Windows machine and don't use Python. Are there any setup steps that I can follow to use your solution?
Thanks in advance,
Ann

Release/6.0 Readme

Update boilerplate text for release/6.0 readme

Mad-Hatter Readme

Update boilerplate text for mad-hatter readme

Mad-Hatter Gradle Build

Remove asciidoctor, watch, livereload from gradle build

Release/6.0 Gradle Build

Remove asciidoctor, watch, livereload from gradle build

Mad-Hatter ns_server and view_engine specs

Copy latest versions of the ns_server and view_engine specs from the master, localhost, or new-spec branches to their own subfolders.

Release/6.0 ns_server and view_engine specs

Copy latest versions of the ns_server and view_engine specs from the master, localhost, or new-spec branches to their own subfolders.