Git Product home page Git Product logo

echo-to-swagger's Introduction

Echo to Swagger Sample

This project is using Echo framework as another demonstration of using Swag package to convert Go annotations to Swagger Documentation 2.0.

For simplicity reasons, this repo doesn't use any database or local storage.

Dependencies

  • Go 1.12.6 or newer
  • Swag

Installation

  • Get swag
$ go get -u github.com/swaggo/swag/cmd/swag
  • Add swag to PATH
$ export PATH=$PATH:$GOPATH/bin

How to use this repo

  • First clone this repo by opening Terminal and executing this command:
$ git clone https://github.com/gamertense/echo-to-swagger
  • Run swag init command:
$ cd echo-to-swagger
$ swag init

See generated swagger.yaml and the rest in echo-to-swagger/docs folder.

alt text

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.