Git Product home page Git Product logo

rest-api's Introduction

rest-api

Template REST api

To run

$ make local

Frame get health

Collect metrics

Add opentracing

Add docs api by swagger

go get swagger: go get -u github.com/swaggo/swag/cmd/swag

generate doc: swag init -g cmd/server/main.go

Add some description:

// @title Go Learn REST API
// @version 1.0
// @description Golang REST API
// @contact.name Duc PX
// @contact.url https://github.com/ducpx
// @contact.email [email protected]
// @BasePath /api/v1

In handler, register docs api to server

import (
    _ "github.com/ducpx/rest-api/docs"
    echoSwagger "github.com/swaggo/echo-swagger"
)

...

    e.GET("/swagger/*", echoSwagger.WrapHandler)

rest-api's People

Contributors

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