Socket
Book a DemoInstallSign in
Socket

fleek-mock

Package Overview
Dependencies
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

fleek-mock

A quick Mock API builder based on the Fleek framework, Swagger Docs, & Mongoose Models

1.0.0
latest
Source
npmnpm
Version published
Weekly downloads
0
-100%
Maintainers
1
Weekly downloads
 
Created
Source

fleek-mock

Goals of Project

  • Dynamic scaffolded API based off of Swagger Documentation and Models
  • Ability for application developers whom need an API for testing and rapid prototyping

How To

  • Create Models
    • These models are a 1:1 relationship with primary route tags
    • The models are mongoose models
    • A models.json or models.js must exist with all the models
  • Create Swagger Documentation
    • Swagger Documentation must follow the Fleek Specifications
    • Primary Tags of the routes are treated as controllers
    • Naming of primary definitions are as such [tag].[method]
    • Naming of definitions are as such [tag].[method].[type]

Prerequisites

  • MongoDB
  • Node.js < (4.x.x)

Run

npm install
MONGO_URI=mongodb://127.0.0.1/fleek npm start

Swagger

http://[path_of_application]/swagger

Todo

  • Build out as library whereby only swagger.json and a model.json/model.js file is required
  • Injectable Middleware rather than forking the present project and adding to the middleware directory

Notes

  • Basic version created on 04/14/2016

Authors

  • Peter A. Tariche

Keywords

Fleek

FAQs

Package last updated on 16 May 2016

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

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.