Code Monkey home page Code Monkey logo

swamd's Introduction

swamd

Command line tool parses go files with swagger annotations and creates markdown file with API specs.

Usage of swamd:
  -o, --o string   Output file to write API specifications to. (default "api_spec.md")
  -p, --p string   Target path to parse Go files from. (default ".")

Not ideal example

From

// CreateCourse creates course
//
// @Summary      Creates course
// @Description  create course
// @Tags         courses
// @Accept       json
// @Produce      plain/text
// @Param 		 request 	body 	CourseCreateRequest true "course create params"
// @Success      200  {string}	string "Course unique identifier"
// @Router       /courses [post]

To

[POST] /courses
summary Creates course
description create course
Tags courses
Accept json
Produce plain/text
Params request body {CourseCreateRequest} required – "course create params"
Responses 200 {string} string "Course unique identifier"

swamd's People

Contributors

ixalender 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.