Merge pull request #24 from communitybridge/fixDocs

daesu · web-flow · commit f3a18e20f699 · 2019-12-14T17:32:52.000+09:00
update docs and fix swagger importation issue
diff --git a/health/doc.go b/health/doc.go
@@ -0,0 +1,55 @@
+package health
+
+import (
+	"net/http"
+
+	"github.com/go-openapi/runtime"
+)
+
+// GetDocOKCode is the HTTP code returned for type GetDocOK
+const GetDocOKCode int = 200
+
+// GetDocOK Success
+type GetDocOK struct {
+}
+
+// NewGetDocOK creates GetDocOK with default headers values
+func NewGetDocOK() *GetDocOK {
+	return &GetDocOK{}
+}
+
+// WriteResponse to the client
+func (o *GetDocOK) WriteResponse(rw http.ResponseWriter, producer runtime.Producer) {
+	html := `<!DOCTYPE html>
+	<html>
+	  <head>
+		<title>Organization Service ReDoc</title>
+		<!-- needed for adaptive design -->
+		<meta charset="utf-8"/>
+		<meta name="viewport" content="width=device-width, initial-scale=1">
+		<link rel="shortcut icon" href="https://www.linuxfoundation.org/wp-content/uploads/2017/08/favicon.png">
+		<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
+
+		<!--
+		ReDoc doesn't change outer page styles
+		-->
+		<style>
+		  body {
+			margin: 0;
+			padding: 0;
+		  }
+		</style>
+	  </head>
+	  <body>
+	    <redoc spec-url='/cbledger/swagger.json'></redoc>
+		<script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"></script>
+	  </body>
+	</html>`
+
+	rw.Header().Set("Content-Type", "text/html; charset=utf-8")
+	rw.WriteHeader(GetDocOKCode)
+	_, err := rw.Write([]byte(html))
+	if err != nil {
+		panic(err)
+	}
+}
diff --git a/health/handlers.go b/health/handlers.go
@@ -2,6 +2,7 @@ package health
 
 import (
 	"github.com/communitybridge/ledger/gen/restapi/operations"
+	"github.com/communitybridge/ledger/gen/restapi/operations/doc"
 	"github.com/communitybridge/ledger/gen/restapi/operations/health"
 	log "github.com/communitybridge/ledger/logging"
 	"github.com/communitybridge/ledger/swagger"
@@ -14,7 +15,7 @@ func Configure(api *operations.LedgerAPI, service Service) {
 	api.DocGetDocHandler = doc.GetDocHandlerFunc(func(params doc.GetDocParams) middleware.Responder {
 		return NewGetDocOK()
 	})
-	
+
 	api.HealthGetHealthHandler = health.GetHealthHandlerFunc(func(params health.GetHealthParams) middleware.Responder {
 		log.Info("entered GetHealthHandler")
 		result, err := service.GetHealth(params.HTTPRequest.Context())
diff --git a/main.go b/main.go
@@ -7,7 +7,6 @@ import (
 
 	"github.com/communitybridge/ledger/balance"
 	"github.com/communitybridge/ledger/cmd"
-	"github.com/communitybridge/ledger/docs"
 	"github.com/communitybridge/ledger/gen/restapi"
 	"github.com/communitybridge/ledger/gen/restapi/operations"
 	"github.com/communitybridge/ledger/health"
@@ -66,8 +65,6 @@ func main() {
 	}
 	api := operations.NewLedgerAPI(swaggerSpec)
 
-	docs.Configure(api)
-
 	// Health setup
 	healthService := health.New()
 	health.Configure(api, healthService)
diff --git a/swagger/ledger.yaml b/swagger/ledger.yaml
@@ -38,7 +38,7 @@ paths:
         200:
           description: Success
       tags:
-        - docs
+        - doc
 
   /balance/{entity_id}:
     get:
