Presidium includes a Golang tool (presidium-oapi3) for importing your OpenAPI 3 spec into Presidium documentation.
- Install the presidium-oapi3 tool using Homebrew:
brew install SPANDigital/tap/presidium-oapi3
Example:
$ presidium-oapi3 convert -f <YOUR_API_SPEC> -o <THE_OUTPUT_DIRECTORY> -r <THE_PRESIDIUM_REFERENCE_URL>
The following options are available for presidium-oapi3:
| Option | Description |
|---|---|
-n, --apiName string | The name under which the generated docs will be grouped |
-f, --file string | OpenAPI 3 spec file |
-o, --outputDir string | The output directory |
-r, --referenceURL string | The reference URL (default “reference”) |
| -h, --help | help for convert |