Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

rest-api-doc

Package Overview
Dependencies
Maintainers
1
Versions
4
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

rest-api-doc

rest-api-doc =====================================

  • 0.3.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

rest-api-doc

Put you API in api directory:

put your apis here

install

npm install
npm install -g gulp

Run dev

gulp dev

deploy dev

gulp deploy-dev

Run production

gulp prod

api doc structure

name: String
baseUrl: String
description: String
apis: [{
  title: String
  description: String   # optional
  url: String
  method: String    # POST, GET

  body: bodyStructure

  successResponse: successResponseStructure

  errorResponse: errorResponseStructure
}]

Keywords

FAQs

Package last updated on 11 Sep 2015

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc