npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

presidium-oapi-3

v2.11.8

Published

A Golang based tool for importing your Open API v3 spec into Presidium Documentation

Downloads

7

Readme

Presidium OpenAPI 3

A Golang tool for importing your OpenAPI 3 spec into Presidium documentation.

Generation

This tool can be run as a:

  • Standalone executable:
  • Part of your Presidium Project

Install

Install presidium-oapi3 globally

With Brew - Recommended for ARM64

brew tap SPANDigital/homebrew-tap https://github.com/SPANDigital/homebrew-tap.git
brew install presidium-oapi3

With NPM

npm install -g presidium-oapi-3

Run

Execute presidium-oapi3 will print the usage:

presidium-oapi3 -h
A Presidium tool that converts OAPI3 spec's to markdown

Usage:
  presidium-oapi3 [flags]
  presidium-oapi3 [command]

Available Commands:
  convert     Converts an OpenAPI 3 spec to markdown
  help        Help about any command

Flags:
  -h, --help   help for presidium-oapi3

Use "presidium-oapi3 [command] --help" for more information about a command.

To convert a file you can use the convert command:

Usage:
  presidium-oapi3 convert [flags]

Flags:
  -e, --allowExternalRefs     Allow external references in the OpenAPI spec. 
  -n, --apiName string        The name under which the generated docs will be grouped
  -f, --file string           OpenAPI 3 spec file
      --includeExamples       Include a column on the schema for examples
      --includeRestrictions   Include a column on the schema for restrictions (default true)
  -i, --inlineProperties      Inline properties in the request and response schemas
  -o, --outputDir string      The output directory
  -r, --referenceURL string   The reference URL (default "reference")
  -s, --sortFilePath          Sort by filepath by prefixing a weight to the filename. Default is to use front matter weight
  -t, --titleFormat string    The template format used to create the title for each operation. 
                              Valid options are: 
                                - operationId: (Default) Uses the value of the operationId field.
                                - MethodURL: Uses a combination of the Method property and the URL.

Sample usage:

presidium-oapi3 convert -f api-spec.yaml -o /project/root/path

The converter will store the Markdown under the /reference directory by default, but you can change it by using the -r, --referenceURL flag.

presidium-oapi3 convert -f example.yaml -o /project/root/path -r /custom/path

Part Of Your Project

Include as part of the npm build building your Presidium site as in the following sample:

"scripts" : {
    "import-open-api-3" : "presidium-oapi3 convert -f <YOUR_API_SPEC> -o <THE_OUTPUT_DIRECTORY> -r <THE_PRESIDIUM_REFERENCE_URL>"
},
"devDependencies": {
    "presidium-oapi-3" : "#.#.#"
}