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

apige

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

apige

  • 0.1.1
  • Rubygems
  • Socket score

Version published
Maintainers
1
Created
Source

Apige

Just another api doc generator.

Installation

Add this line to your application's Gemfile:

gem 'apige'

And then execute:

$ bundle

Or install it yourself as:

$ gem install apige

Usage

Initialize:

# Will create default apige folder with default template and demo files.
apige init
# Create with specific folder
apige init /apidoc

Then

# This will create md files in apige/docs/#{version}(optional)/#{api_filename}.md.
apige compile

FAQ

How to custom template?

Just modify temlate file in apige/templates.

Structure.

  • HEAD

  • API Content(Render in defined order)

References

Configuration

  • templates: Required, Hash
  • date
  • version
  • author
  • meta

Scope Method

group & resources
  • desc
  • meta
get/put/post/delete
  • title
  • desc
  • meta
  • params
  • required

Template Varable

  • head: all config value
  • group: level name description parent children type apis
  • resources: Same with group
  • api: level title path method params response_value

WIP

  • Mock server
  • Support Api blueprint format.

FAQs

Package last updated on 25 Apr 2017

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