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

apidoc-openapi-3-1

v1.0.4

Published

Utility for generate documentation of API like project.

Downloads

368

Readme

apidoc-openapi-3-1

Apidoc and swagger are two nice projects which are focusing on documentation of APIs. This project is a middle tier which tries to bring them together in a sense that:

It uses apidoc to convert inline documentation comments into json schema and later convert it to swagger json schema.

Uses the apidoc-light library.

Why use it

Inspired by apidoc-swagger-3

The old repo may not be maintained, and not support new api-doc feature

and this repo adds new feature

  • **support request @apiBody @apiQuery **
  • **support response @apiSuccess/Example @apiError/Example **

How It Works

By putting in line comments in the source code like this in javascript, you will get swagger.json file which can be served to swagger-ui, y-api to generate html overview of documentation.

/schema/demo.js:

/**
 * @api {post} /test_api/:id desc_test_api
 * @apiName test_api_name
 * @apiGroup search
 *
 * @apiHeader {String} [taz] desc_taz
 *
 * @apiParam {Number} id Unique ID
 *
 * @apiParam {Number} [tar] desc_tar
 *
 * @apiParam (Body) {Object[]} foo desc_foo
 * @apiParam (Body) {String} foo.foz desc_foo.foz
 * @apiBody {String} foo.fizz desc_foo.fizz
 *
 * @apiParam (Query) {String} bar=bar desc_bar
 * @apiQuery {String} baz=baz desc_baz
 *
 * @apiParamExample {json} request_desc
 * {{extraExample}}
 *
 * @apiSuccess {Number} [code=1] desc_override_code
 * @apiSuccess {Object} data data_desc
 * @apiSuccess {number} data.keyInDoc desc_add_extra_data_key_in_doc
 *
 * @apiSuccessExample {json} response_desc
 * HTTP/1.1 200 OK
 *  {
 "code": 200,
 "data": {
 "keyInExample": 1
 }
 }
 *
 * @apiSuccessExample {json} error_desc
 * HTTP/1.1 300 OK
 * {{fooInJs:barInJs}}
 */

it will output json swagger.json

Tips

you should always use command apidoc-openapi-3-1 directly, if you use npx apidoc-openapi-3-1, this lib is not able to find hook, replacing mark would be failed