@apidevtools/swagger-methods

Swagger Methods

HTTP methods that are supported by Swagger 2.0

This is an array of lower-case HTTP method names that are supported by the Swagger 2.0 spec.

This module is tested against the Swagger 2.0 schema

Installation

Install using npm:

npm install @apidevtools/swagger-methods

Usage

var methods = require('@apidevtools/swagger-methods');

methods.forEach(function(method) {
  console.log(method);
});

// get
// put
// post
// delete
// options
// head
// patch

Contributing

I welcome any contributions, enhancements, and bug-fixes. Open an issue on GitHub and submit a pull request.

Building/Testing

To build/test the project locally on your computer:

• Clone this repo
  git clone https://github.com/APIDevTools/swagger-methods.git

• Install dev dependencies
  npm install

• Run the unit tests
  npm test

License

MIT license. Use it however you want.

This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

Big Thanks To

Thanks to these awesome companies for their support of Open Source developers ❤

Similar packages

Other packages similar to @apidevtools/swagger-methods

swagger-jsdoc

swagger-jsdoc is a package that allows you to integrate JSDoc comments with Swagger/OpenAPI documentation. It provides more comprehensive functionality for generating Swagger documentation from your code comments, whereas @apidevtools/swagger-methods is focused solely on providing a list of HTTP methods.

swagger-parser

swagger-parser is a powerful tool for parsing, validating, and dereferencing Swagger/OpenAPI definitions. It offers more advanced features for working with Swagger documents compared to @apidevtools/swagger-methods, which only provides a list of HTTP methods.

openapi-types

openapi-types provides TypeScript types for OpenAPI specifications. It is useful for developers working with TypeScript who need type definitions for OpenAPI objects. In contrast, @apidevtools/swagger-methods is a simple utility for HTTP methods.