<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0">
<base href="https://issues.jboss.org">
<title>Message Title</title>
</head>
<body class="jira" style="color: #333333; font-family: Arial, sans-serif; font-size: 14px; line-height: 1.429">
<table id="background-table" cellpadding="0" cellspacing="0" width="100%" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; background-color: #f5f5f5; border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt" bgcolor="#f5f5f5">
<!-- header here -->
<tbody>
<tr>
<td id="header-pattern-container" style="padding: 0px; border-collapse: collapse; padding: 10px 20px">
<table id="header-pattern" cellspacing="0" cellpadding="0" border="0" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt">
<tbody>
<tr>
<td id="header-avatar-image-container" valign="top" style="padding: 0px; border-collapse: collapse; vertical-align: top; width: 32px; padding-right: 8px" width="32"> <img id="header-avatar-image" class="image_fix" src="https://static.jboss.org/developer/gravatar/bd1946aafd256fc8796cd927befe1353?d=mm&s=48" height="32" width="32" border="0" style="border-radius: 3px; vertical-align: top"> </td>
<td id="header-text-container" valign="middle" style="padding: 0px; border-collapse: collapse; vertical-align: middle; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 1px"> <a class="user-hover" rel="cmacedo86" id="email_cmacedo86" href="https://issues.jboss.org/secure/ViewProfile.jspa?name=cmacedo86" style="color:#0052cc;; color: #3b73af; text-decoration: none">Camila Macedo</a> <strong>edited a comment</strong> on <a href="https://issues.jboss.org/browse/AEROGEAR-8477" style="color: #3b73af; text-decoration: none"><img src="cid:jira-generated-image-avatar-945fc2b6-7df8-48be-b19f-d3b1eb41080b" height="16" width="16" border="0" align="absmiddle" alt="Task"> AEROGEAR-8477</a> </td>
</tr>
</tbody>
</table> </td>
</tr>
<tr>
<td id="email-content-container" style="padding: 0px; border-collapse: collapse; padding: 0 20px">
<table id="email-content-table" cellspacing="0" cellpadding="0" border="0" width="100%" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-spacing: 0; border-collapse: separate">
<tbody>
<tr>
<!-- there needs to be content in the cell for it to render in some clients -->
<td class="email-content-rounded-top mobile-expand" style="padding: 0px; border-collapse: collapse; color: #ffffff; padding: 0 15px 0 16px; height: 15px; background-color: #ffffff; border-left: 1px solid #cccccc; border-top: 1px solid #cccccc; border-right: 1px solid #cccccc; border-bottom: 0; border-top-right-radius: 5px; border-top-left-radius: 5px; height: 10px; line-height: 10px; padding: 0 15px 0 16px; mso-line-height-rule: exactly" height="10" bgcolor="#ffffff"> </td>
</tr>
<tr>
<td class="email-content-main mobile-expand " style="padding: 0px; border-collapse: collapse; border-left: 1px solid #cccccc; border-right: 1px solid #cccccc; border-top: 0; border-bottom: 0; padding: 0 15px 0 16px; background-color: #ffffff" bgcolor="#ffffff">
<table class="page-title-pattern" cellspacing="0" cellpadding="0" border="0" width="100%" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt">
<tbody>
<tr>
<td style="vertical-align: top;; padding: 0px; border-collapse: collapse; padding-right: 5px; font-size: 20px; line-height: 30px; mso-line-height-rule: exactly" class="page-title-pattern-header-container"> <span class="page-title-pattern-header" style="font-family: Arial, sans-serif; padding: 0; font-size: 20px; line-height: 30px; mso-text-raise: 2px; mso-line-height-rule: exactly; vertical-align: middle"> <a href="https://issues.jboss.org/browse/AEROGEAR-8477" style="color: #3b73af; text-decoration: none">Re: Find out how to generated swagger api doc from the source code</a> </span> </td>
</tr>
</tbody>
</table> </td>
</tr>
<tr>
<td id="text-paragraph-pattern-top" class="email-content-main mobile-expand comment-top-special-margin comment-top-pattern" style="padding: 0px; border-collapse: collapse; border-left: 1px solid #cccccc; border-right: 1px solid #cccccc; border-top: 0; border-bottom: 0; padding: 0 15px 0 16px; background-color: #ffffff; border-bottom: none; padding-bottom: 0" bgcolor="#ffffff">
<table class="text-paragraph-pattern" cellspacing="0" cellpadding="0" border="0" width="100%" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 2px">
<tbody>
<tr>
<td class="text-paragraph-pattern-container mobile-resize-text " style="padding: 0px; border-collapse: collapse; padding: 0 0 10px 0; padding-top: 10px"> <span class="diffremovedchars" style="background-color:#ffe7e7;text-decoration:line-through;">IN PROGRESS:<br><br></span> <span class="diffcontext">h3. Libs<br>Following the libs found which show able to generated the swagger from the code.<br><br>h4. beego_api<br>* https://beego.me/blog/beego_api<br><br>h4. go-swagger<br>* https://github.com/go-swagger/go-swagger<br><br>h5. Links/Articles <br>* http://bigk.me/swagger/golang/go/2017/07/30/golang-and-openapi-how-to-create-documentation-for-your-rest-api-services/<br>* https://labs.bawi.io/documenting-an-api-with-swagger-cb106250239f<br><br>h3. Analyse over the libs<br>- Shows that go-swagger it is the official one used for more people. <br>- Aerogear metrics project is already using it<br><br>h3. POC tests <br>Done locally and worked as follows. <br><br>h4. main.go<br><br>{code:java}<br>// API for Mobile Security Service<br>// Schemes: http, https<br>// Title: Mobile Security Service Server API<br>// Description: This is a sample mobile security service server.<br>// Version: 1.0.0<br>//<br>// Consumes:<br>// - application/json<br>//<br>// Produces:<br>// - application/json<br>//<br>// Host: localhost:3000<br>//<br>//<br>// swagger:meta<br>package main<br><br>//go:generate swagger generate spec -m -o ../../api/swagger.yaml<br><br>import (<br> "github.com/aerogear/mobile-security-service/pkg/config"<br> "github.com/aerogear/mobile-security-service/pkg/web/apps"<br> "github.com/aerogear/mobile-security-service/pkg/web/router"<br> dotenv "github.com/joho/godotenv"<br> "github.com/labstack/echo"<br> log "github.com/sirupsen/logrus"<br>)<br><br>func init() {<br> config := config.Get()<br><br> initLogger(config.LogLevel, config.LogFormat)<br><br> err := dotenv.Load()<br><br> if err != nil {<br> log.Info("No .env file found, using default values instead.")<br> }<br>}<br><br>func main() {<br> config := config.Get()<br><br> e := router.NewRouter(config)<br><br> initHandlers(e, config)<br><br> // start webserver<br> if err := e.Start(config.ListenAddress); err != nil {<br> panic("failed to start" + err.Error())<br> }<br>}<br><br>func initLogger(level, format string) {<br> logLevel, err := log.ParseLevel(level)<br><br> if err != nil {<br> log.Fatalf("log level %v is not allowed. Must be one of [debug, info, warning, error, fatal, panic]", level)<br> logLevel = log.InfoLevel<br> }<br><br> log.SetLevel(logLevel)<br><br> switch format {<br> case "json":<br> log.SetFormatter(&log.JSONFormatter{})<br> case "text":<br> log.SetFormatter(&log.TextFormatter{DisableColors: true})<br> default:<br> log.Fatalf("log format %v is not allowed. Must be one of [text, json]", format)<br> }<br>}<br><br>// Invoke handlers, services and repositories here<br>func initHandlers(e *echo.Echo, c config.Config) {<br> // Prefix api routes<br> apiRoutePrefix := c.ApiRoutePrefix<br> apiGroup := e.Group(apiRoutePrefix)<br><br> // App handler setup<br> appsPostgreSQLRepository := apps.NewPostgreSQLRepository()<br> appsService := apps.NewService(appsPostgreSQLRepository)<br> appsHandler := apps.NewHTTPHandler(e, appsService)<br><br> // Setup routes<br> router.SetAppRoutes(apiGroup, appsHandler)<br>}<br><br>{code}<br><br>router.go<br><br>{code:java}<br>func SetAppRoutes(r *echo.Group, appsHandler *apps.HTTPHandler) {<br> // swagger:operation GET /apps apps<br> //<br> // ---<br> // produces:<br> // - application/json<br> // responses:<br> // '200':<br> // description: successful operation<br> r.GET("/apps", appsHandler.GetApps)<br>{code}<br><br>After running the command `$swagger generate spec -m -o ../../api/swagger.yaml` it worked and generate the file as follows. <br><br>{code:java}<br><br>consumes:<br>- application/json<br>host: localhost:3000<br>info:<br> description: API for Mobile Security Service<br> version: 1.0.0<br>paths:<br> /apps:<br> get:<br> operationId: apps<br> produces:<br> - application/json<br> responses:<br> "200":<br> description: successful operation<br>produces:<br>- application/json<br>schemes:<br>- http<br>- https<br>swagger: "2.0"<br>{code}<br><br></span> </td>
</tr>
</tbody>
</table> </td>
</tr>
<tr>
<td class="email-content-main mobile-expand " style="padding: 0px; border-collapse: collapse; border-left: 1px solid #cccccc; border-right: 1px solid #cccccc; border-top: 0; border-bottom: 0; padding: 0 15px 0 16px; background-color: #ffffff" bgcolor="#ffffff">
<table id="actions-pattern" cellspacing="0" cellpadding="0" border="0" width="100%" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 1px">
<tbody>
<tr>
<td id="actions-pattern-container" valign="middle" style="padding: 0px; border-collapse: collapse; padding: 10px 0 10px 24px; vertical-align: middle; padding-left: 0">
<table align="left" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt">
<tbody>
<tr>
<td class="actions-pattern-action-icon-container" style="padding: 0px; border-collapse: collapse; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 0; vertical-align: middle"> <a href="https://issues.jboss.org/browse/AEROGEAR-8477#add-comment" target="_blank" title="Add Comment" style="color: #3b73af; text-decoration: none"> <img class="actions-pattern-action-icon-image" src="cid:jira-generated-image-static-comment-icon-a586f3f4-1b99-483a-813a-1b74e6fb3d37" alt="Add Comment" title="Add Comment" height="16" width="16" border="0" style="vertical-align: middle"> </a> </td>
<td class="actions-pattern-action-text-container" style="padding: 0px; border-collapse: collapse; font-family: Arial, sans-serif; font-size: 14px; line-height: 20px; mso-line-height-rule: exactly; mso-text-raise: 4px; padding-left: 5px"> <a href="https://issues.jboss.org/browse/AEROGEAR-8477#add-comment" target="_blank" title="Add Comment" style="color: #3b73af; text-decoration: none">Add Comment</a> </td>
</tr>
</tbody>
</table> </td>
</tr>
</tbody>
</table> </td>
</tr>
<!-- there needs to be content in the cell for it to render in some clients -->
<tr>
<td class="email-content-rounded-bottom mobile-expand" style="padding: 0px; border-collapse: collapse; color: #ffffff; padding: 0 15px 0 16px; height: 5px; line-height: 5px; background-color: #ffffff; border-top: 0; border-left: 1px solid #cccccc; border-bottom: 1px solid #cccccc; border-right: 1px solid #cccccc; border-bottom-right-radius: 5px; border-bottom-left-radius: 5px; mso-line-height-rule: exactly" height="5" bgcolor="#ffffff"> </td>
</tr>
</tbody>
</table> </td>
</tr>
<tr>
<td id="footer-pattern" style="padding: 0px; border-collapse: collapse; padding: 12px 20px">
<table id="footer-pattern-container" cellspacing="0" cellpadding="0" border="0" style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt">
<tbody>
<tr>
<td id="footer-pattern-text" class="mobile-resize-text" width="100%" style="padding: 0px; border-collapse: collapse; color: #999999; font-size: 12px; line-height: 18px; font-family: Arial, sans-serif; mso-line-height-rule: exactly; mso-text-raise: 2px"> This message was sent by Atlassian Jira <span id="footer-build-information">(v7.12.1#712002-<span title="609a50578ba6bc73dbf8b05dddd7c04a04b6807c" data-commit-id="609a50578ba6bc73dbf8b05dddd7c04a04b6807c}">sha1:609a505</span>)</span> </td>
<td id="footer-pattern-logo-desktop-container" valign="top" style="padding: 0px; border-collapse: collapse; padding-left: 20px; vertical-align: top">
<table style="border-collapse: collapse; mso-table-lspace: 0pt; mso-table-rspace: 0pt">
<tbody>
<tr>
<td id="footer-pattern-logo-desktop-padding" style="padding: 0px; border-collapse: collapse; padding-top: 3px"> <img id="footer-pattern-logo-desktop" src="https://issues.jboss.org/images/mail/atlassian-email-logo.png" alt="Atlassian logo" title="Atlassian logo" width="191" height="24" class="image_fix"> </td>
</tr>
</tbody>
</table> </td>
</tr>
</tbody>
</table> </td>
</tr>
</tbody>
</table>
</body>
</html>