Giter VIP home page Giter VIP logo

swagger's Introduction

Usage

Install

    go get -u github.com/rookiejin/swagger
  • command
swagger -main main.go
  • Model definitions
    package somepkg

    // @def Model  <- defined Model use @def
    type Model struct{
        Id int <- support int* float* , bson.ObjectId , if it`s array please use definitions
        SomeArray []Array `swag:"Array"` <- the Array should be defined
    }
    // @def Array
    type Array struct {
        SomeStruct string
    }
  • Param definitions
    // @Param fieldName InWhere Type isRequired Description
    // @Param name query string true "name of the pets"
    // @Param file formData file true  "the file to upload "
    // @Param pets body @Model true "the defined model"
    // @Param page path string false "page in path"
  • Response definitions
    // @Success 200 {object} @ArticleTag "ok"
    // @Failure 400 {object} @ArticleTag "error message"

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.