Giter Club home page Giter Club logo

autoswagger.lua's Introduction

autoswagger.lua

This Lua module can learn from a set of "raw" server traces and build a swagger spec with them.

It is intelligent enough to deduce common parameters from numbers or ids on the urls.

installation and usage

Copy the autoswagger folder inside your app. Then:

local autoswagger = require 'autoswagger' -- or 'autoswagger.init', depending on your package.path config

local brain = autoswagger.Brain:new()

brain:learn('GET', 'google.com', '/users/1/app/5')
brain:learn('GET', 'google.com', '/users/2/app/4')
brain:learn('GET', 'google.com', '/users/3/app/3')
brain:learn('GET', 'google.com', '/users/4/app/2')
brain:learn('GET', 'google.com', '/users/5/app/1')

brain:get_swagger('google.com') -- returns the swagger spec that the brain has learned from google.com. It probably includes /users/{user_id}/app/{app_id} as an operation.

specs

This project uses busted for its specs. Just execute busted inside the root of the repo.

autoswagger.lua's People

Contributors

kikito avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.