Meshery: Meshery: API documentation for endpoints in server.go

[leecalcote]

Current Behavior
Meshery's REST API endpoints are defined in server.go, but not well-commented or externally documented.

Desired Behavior
Using Swagger, Meshery's REST API documentation should be auto-generated and published. Ideally, published to the Meshery documentation site (https://github.com/layer5io/meshery/blob/master/docs), if feasible.

---

Resources

• https://towardsdatascience.com/setting-up-swagger-docs-for-golang-api-8d0442263641

[kushthedude]

@nupur-thakur Any updates over here ?

[NupurThakur27]

@kushthedude I wanted to learn about swagger when i assigned this task to myself and I searched a bit but got stuck and then I forgot about this issue, sorry for that.
But if recently when @leecalcote mentioned it in #780 It got my attention so I will start working on it again.
If you already know about swagger and have some time could you please help me with this?

[kushthedude]

@nupur-thakur I thing swaggo will be better for us, as it is a lot simpler and lighter than go-swagger. Also, @leecalcote Where are we planning to host the API documentation. Do we need auto-deploy with every commit ?

[kushthedude]

Also, will we need dredd after setting up API documentation?

[chandrashritii]

@leecalcote If this hasn't been resolved yet, I'll like to work on this. I have looked into using Swagger and as @kushthedude said, swaggo will be a better option to use here.

[leecalcote]

Green light here. Yes, Swaggo supports both net/http and Gorilla, which is great.

[Documentus]

Is there space for a newbie to jump in for learning purposes and a portfolio item please?

[PluckyPrecious]

Hi @Documentus sure there’s more than enough space👏🏽, I hope it’s not too late? I welcome you to join the Layer5 community here - http://slack.layer5.io to collaborate with other contributors.