├── .gitignore
├── LICENSE
├── README.md
├── bindata_assetfs.go
├── doc.go
├── generate.go
├── glide.yaml
├── handler.go
├── index.tpl.go
├── static
├── css
│ ├── print.css
│ ├── reset.css
│ ├── screen.css
│ ├── style.css
│ └── typography.css
├── fonts
│ ├── DroidSans-Bold.ttf
│ └── DroidSans.ttf
├── images
│ ├── collapse.gif
│ ├── expand.gif
│ ├── explorer_icons.png
│ ├── favicon-16x16.png
│ ├── favicon-32x32.png
│ ├── favicon.ico
│ ├── logo_small.png
│ ├── pet_store_api.png
│ ├── throbber.gif
│ └── wordnik_api.png
├── lang
│ ├── en.js
│ ├── es.js
│ ├── fr.js
│ ├── geo.js
│ ├── it.js
│ ├── ja.js
│ ├── pl.js
│ ├── pt.js
│ ├── ru.js
│ ├── tr.js
│ ├── translator.js
│ └── zh-cn.js
├── lib
│ ├── backbone-min.js
│ ├── handlebars-2.0.0.js
│ ├── highlight.9.1.0.pack.js
│ ├── highlight.9.1.0.pack_extended.js
│ ├── jquery-1.8.0.min.js
│ ├── jquery.ba-bbq.min.js
│ ├── jquery.slideto.min.js
│ ├── jquery.wiggle.min.js
│ ├── js-yaml.min.js
│ ├── jsoneditor.min.js
│ ├── lodash.min.js
│ ├── marked.js
│ ├── object-assign-pollyfill.js
│ └── swagger-oauth.js
├── o2c.html
├── swagger-ui.js
└── swagger-ui.min.js
└── swgui-server
└── main.go
/.gitignore:
--------------------------------------------------------------------------------
1 | ### Go template
2 | # Compiled Object files, Static and Dynamic libs (Shared Objects)
3 | *.o
4 | *.a
5 | *.so
6 |
7 | # Folders
8 | _obj
9 | _test
10 |
11 | # Architecture specific extensions/prefixes
12 | *.[568vq]
13 | [568vq].out
14 |
15 | *.cgo1.go
16 | *.cgo2.c
17 | _cgo_defun.c
18 | _cgo_gotypes.go
19 | _cgo_export.*
20 |
21 | _testmain.go
22 |
23 | *.exe
24 | *.test
25 | *.prof
26 |
27 | # Created by .ignore support plugin (hsz.mobi)
28 |
29 | /vendor/
30 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | Apache License
2 | Version 2.0, January 2004
3 | http://www.apache.org/licenses/
4 |
5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6 |
7 | 1. Definitions.
8 |
9 | "License" shall mean the terms and conditions for use, reproduction,
10 | and distribution as defined by Sections 1 through 9 of this document.
11 |
12 | "Licensor" shall mean the copyright owner or entity authorized by
13 | the copyright owner that is granting the License.
14 |
15 | "Legal Entity" shall mean the union of the acting entity and all
16 | other entities that control, are controlled by, or are under common
17 | control with that entity. For the purposes of this definition,
18 | "control" means (i) the power, direct or indirect, to cause the
19 | direction or management of such entity, whether by contract or
20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the
21 | outstanding shares, or (iii) beneficial ownership of such entity.
22 |
23 | "You" (or "Your") shall mean an individual or Legal Entity
24 | exercising permissions granted by this License.
25 |
26 | "Source" form shall mean the preferred form for making modifications,
27 | including but not limited to software source code, documentation
28 | source, and configuration files.
29 |
30 | "Object" form shall mean any form resulting from mechanical
31 | transformation or translation of a Source form, including but
32 | not limited to compiled object code, generated documentation,
33 | and conversions to other media types.
34 |
35 | "Work" shall mean the work of authorship, whether in Source or
36 | Object form, made available under the License, as indicated by a
37 | copyright notice that is included in or attached to the work
38 | (an example is provided in the Appendix below).
39 |
40 | "Derivative Works" shall mean any work, whether in Source or Object
41 | form, that is based on (or derived from) the Work and for which the
42 | editorial revisions, annotations, elaborations, or other modifications
43 | represent, as a whole, an original work of authorship. For the purposes
44 | of this License, Derivative Works shall not include works that remain
45 | separable from, or merely link (or bind by name) to the interfaces of,
46 | the Work and Derivative Works thereof.
47 |
48 | "Contribution" shall mean any work of authorship, including
49 | the original version of the Work and any modifications or additions
50 | to that Work or Derivative Works thereof, that is intentionally
51 | submitted to Licensor for inclusion in the Work by the copyright owner
52 | or by an individual or Legal Entity authorized to submit on behalf of
53 | the copyright owner. For the purposes of this definition, "submitted"
54 | means any form of electronic, verbal, or written communication sent
55 | to the Licensor or its representatives, including but not limited to
56 | communication on electronic mailing lists, source code control systems,
57 | and issue tracking systems that are managed by, or on behalf of, the
58 | Licensor for the purpose of discussing and improving the Work, but
59 | excluding communication that is conspicuously marked or otherwise
60 | designated in writing by the copyright owner as "Not a Contribution."
61 |
62 | "Contributor" shall mean Licensor and any individual or Legal Entity
63 | on behalf of whom a Contribution has been received by Licensor and
64 | subsequently incorporated within the Work.
65 |
66 | 2. Grant of Copyright License. Subject to the terms and conditions of
67 | this License, each Contributor hereby grants to You a perpetual,
68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69 | copyright license to reproduce, prepare Derivative Works of,
70 | publicly display, publicly perform, sublicense, and distribute the
71 | Work and such Derivative Works in Source or Object form.
72 |
73 | 3. Grant of Patent License. Subject to the terms and conditions of
74 | this License, each Contributor hereby grants to You a perpetual,
75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76 | (except as stated in this section) patent license to make, have made,
77 | use, offer to sell, sell, import, and otherwise transfer the Work,
78 | where such license applies only to those patent claims licensable
79 | by such Contributor that are necessarily infringed by their
80 | Contribution(s) alone or by combination of their Contribution(s)
81 | with the Work to which such Contribution(s) was submitted. If You
82 | institute patent litigation against any entity (including a
83 | cross-claim or counterclaim in a lawsuit) alleging that the Work
84 | or a Contribution incorporated within the Work constitutes direct
85 | or contributory patent infringement, then any patent licenses
86 | granted to You under this License for that Work shall terminate
87 | as of the date such litigation is filed.
88 |
89 | 4. Redistribution. You may reproduce and distribute copies of the
90 | Work or Derivative Works thereof in any medium, with or without
91 | modifications, and in Source or Object form, provided that You
92 | meet the following conditions:
93 |
94 | (a) You must give any other recipients of the Work or
95 | Derivative Works a copy of this License; and
96 |
97 | (b) You must cause any modified files to carry prominent notices
98 | stating that You changed the files; and
99 |
100 | (c) You must retain, in the Source form of any Derivative Works
101 | that You distribute, all copyright, patent, trademark, and
102 | attribution notices from the Source form of the Work,
103 | excluding those notices that do not pertain to any part of
104 | the Derivative Works; and
105 |
106 | (d) If the Work includes a "NOTICE" text file as part of its
107 | distribution, then any Derivative Works that You distribute must
108 | include a readable copy of the attribution notices contained
109 | within such NOTICE file, excluding those notices that do not
110 | pertain to any part of the Derivative Works, in at least one
111 | of the following places: within a NOTICE text file distributed
112 | as part of the Derivative Works; within the Source form or
113 | documentation, if provided along with the Derivative Works; or,
114 | within a display generated by the Derivative Works, if and
115 | wherever such third-party notices normally appear. The contents
116 | of the NOTICE file are for informational purposes only and
117 | do not modify the License. You may add Your own attribution
118 | notices within Derivative Works that You distribute, alongside
119 | or as an addendum to the NOTICE text from the Work, provided
120 | that such additional attribution notices cannot be construed
121 | as modifying the License.
122 |
123 | You may add Your own copyright statement to Your modifications and
124 | may provide additional or different license terms and conditions
125 | for use, reproduction, or distribution of Your modifications, or
126 | for any such Derivative Works as a whole, provided Your use,
127 | reproduction, and distribution of the Work otherwise complies with
128 | the conditions stated in this License.
129 |
130 | 5. Submission of Contributions. Unless You explicitly state otherwise,
131 | any Contribution intentionally submitted for inclusion in the Work
132 | by You to the Licensor shall be under the terms and conditions of
133 | this License, without any additional terms or conditions.
134 | Notwithstanding the above, nothing herein shall supersede or modify
135 | the terms of any separate license agreement you may have executed
136 | with Licensor regarding such Contributions.
137 |
138 | 6. Trademarks. This License does not grant permission to use the trade
139 | names, trademarks, service marks, or product names of the Licensor,
140 | except as required for reasonable and customary use in describing the
141 | origin of the Work and reproducing the content of the NOTICE file.
142 |
143 | 7. Disclaimer of Warranty. Unless required by applicable law or
144 | agreed to in writing, Licensor provides the Work (and each
145 | Contributor provides its Contributions) on an "AS IS" BASIS,
146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 | implied, including, without limitation, any warranties or conditions
148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 | PARTICULAR PURPOSE. You are solely responsible for determining the
150 | appropriateness of using or redistributing the Work and assume any
151 | risks associated with Your exercise of permissions under this License.
152 |
153 | 8. Limitation of Liability. In no event and under no legal theory,
154 | whether in tort (including negligence), contract, or otherwise,
155 | unless required by applicable law (such as deliberate and grossly
156 | negligent acts) or agreed to in writing, shall any Contributor be
157 | liable to You for damages, including any direct, indirect, special,
158 | incidental, or consequential damages of any character arising as a
159 | result of this License or out of the use or inability to use the
160 | Work (including but not limited to damages for loss of goodwill,
161 | work stoppage, computer failure or malfunction, or any and all
162 | other commercial damages or losses), even if such Contributor
163 | has been advised of the possibility of such damages.
164 |
165 | 9. Accepting Warranty or Additional Liability. While redistributing
166 | the Work or Derivative Works thereof, You may choose to offer,
167 | and charge a fee for, acceptance of support, warranty, indemnity,
168 | or other liability obligations and/or rights consistent with this
169 | License. However, in accepting such obligations, You may act only
170 | on Your own behalf and on Your sole responsibility, not on behalf
171 | of any other Contributor, and only if You agree to indemnify,
172 | defend, and hold each Contributor harmless for any liability
173 | incurred by, or claims asserted against, such Contributor by reason
174 | of your accepting any such warranty or additional liability.
175 |
176 | END OF TERMS AND CONDITIONS
177 |
178 | APPENDIX: How to apply the Apache License to your work.
179 |
180 | To apply the Apache License to your work, attach the following
181 | boilerplate notice, with the fields enclosed by brackets "{}"
182 | replaced with your own identifying information. (Don't include
183 | the brackets!) The text should be enclosed in the appropriate
184 | comment syntax for the file format. We also recommend that a
185 | file or class name and description of purpose be included on the
186 | same "printed page" as the copyright notice for easier
187 | identification within third-party archives.
188 |
189 | Copyright 2018 Lazada Tech Hub
190 |
191 | Licensed under the Apache License, Version 2.0 (the "License");
192 | you may not use this file except in compliance with the License.
193 | You may obtain a copy of the License at
194 |
195 | http://www.apache.org/licenses/LICENSE-2.0
196 |
197 | Unless required by applicable law or agreed to in writing, software
198 | distributed under the License is distributed on an "AS IS" BASIS,
199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 | See the License for the specific language governing permissions and
201 | limitations under the License.
202 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # Swagger UI
2 |
3 | [](https://godoc.org/github.com/lazada/swgui)
4 |
5 | Package `swgui` (Swagger UI) provide a HTTP handler to serve Swagger UI.
6 | All assets are embedded in GO source code, so just build and run.
7 |
8 | ## How to use
9 |
10 | ```go
11 | package main
12 |
13 | import (
14 | "http"
15 |
16 | "github.com/lazada/swgui"
17 | )
18 |
19 | func main() {
20 | http.Handle("/", swgui.NewHandler("Page title", "path/to/swagger.json", "/"))
21 | http.ListenAndServe(":8080", nil)
22 | }
23 | ```
24 |
25 | ## Run as standalone server
26 |
27 | Install `swgui-server`
28 |
29 | go get github.com/lazada/swgui/...
30 |
31 | Start server
32 |
33 | swgui-server -port 8080
34 |
--------------------------------------------------------------------------------
/doc.go:
--------------------------------------------------------------------------------
1 | // Package swgui provide a http FileSystem handler for swagger UI interface
2 | //
3 | // File `bindata_assetfs.go` is generated by go-bindata-assetfs (https://github.com/elazarl/go-bindata-assetfs) tool,
4 | // which help to embed all static files into a go source file.
5 | //
6 | // How to generate file:
7 | //
8 | // NOTE:
9 | // * File `bindata_assetfs.go` ONLY need to re-generate file again when we update swagger-ui (swagger/ui/static)
10 | //
11 | // 1. Install tools:
12 | //
13 | // go get -u github.com/jteeuwen/go-bindata/...
14 | // go get -u github.com/elazarl/go-bindata-assetfs/...
15 | //
16 | // 2. Generate file:
17 | //
18 | // At root folder, run command:
19 | //
20 | // go-bindata-assetfs -pkg=swgui static/...
21 | // gofmt -w bindata_assetfs.go
22 | //
23 | // Or just run: `go generate`
24 | //
25 | // Enjoy it ;)
26 | //
27 | package swgui
28 |
--------------------------------------------------------------------------------
/generate.go:
--------------------------------------------------------------------------------
1 | package swgui
2 |
3 | //go:generate go-bindata-assetfs -pkg $GOPACKAGE static/...
4 | //go:generate gofmt -w bindata_assetfs.go
5 |
--------------------------------------------------------------------------------
/glide.yaml:
--------------------------------------------------------------------------------
1 | package: github.com/lazada/swgui
2 | import:
3 | - package: github.com/elazarl/go-bindata-assetfs
4 | version: 57eb5e1fc594ad4b0b1dbea7b286d299e0cb43c2
5 | - package: github.com/jteeuwen/go-bindata
6 | version: ~3.0.7
7 |
--------------------------------------------------------------------------------
/handler.go:
--------------------------------------------------------------------------------
1 | package swgui
2 |
3 | import (
4 | "html/template"
5 | "net/http"
6 | )
7 |
8 | var staticServer = http.FileServer(assetFS())
9 |
10 | // Handler handle swagger UI request
11 | type Handler struct {
12 | Title string // title of index file
13 | SwaggerJSON string // path to swagger.json document specification
14 | BasePath string // base path to docs
15 |
16 | JsonEditor bool // Enable visual json editor support (experimental, can fail with complex schemas)
17 |
18 | tpl *template.Template
19 | staticServer http.Handler
20 | }
21 |
22 | // NewHandler returns a HTTP handler for swagger UI
23 | func NewHandler(title, swaggerJSONPath string, basePath string) *Handler {
24 | hdl := &Handler{
25 | Title: title,
26 | SwaggerJSON: swaggerJSONPath,
27 | BasePath: basePath,
28 | }
29 |
30 | hdl.tpl, _ = template.New("index").Parse(indexTpl)
31 | hdl.staticServer = http.StripPrefix(basePath, staticServer)
32 | return hdl
33 | }
34 |
35 | // NewHandlerWithConfig returns a HTTP handler for swagger UI
36 | func NewHandlerWithConfig(handler Handler) *Handler {
37 | hdl := &handler
38 | hdl.tpl, _ = template.New("index").Parse(indexTpl)
39 | hdl.staticServer = http.StripPrefix(handler.BasePath, staticServer)
40 | return hdl
41 | }
42 |
43 | // ServeHTTP implement http.Handler interface, to handle swagger UI request
44 | func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
45 | if r.URL.Path != h.BasePath {
46 | h.staticServer.ServeHTTP(w, r)
47 | return
48 | }
49 |
50 | if err := h.tpl.Execute(w, h); err != nil {
51 | http.NotFound(w, r)
52 | }
53 | }
54 |
--------------------------------------------------------------------------------
/index.tpl.go:
--------------------------------------------------------------------------------
1 | package swgui
2 |
3 | var indexTpl = `
4 |
5 |
6 |