Skip to content
This repository has been archived by the owner on Sep 5, 2023. It is now read-only.

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
longXboy committed May 31, 2021
1 parent c5d7657 commit c12752f
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
# swagger-api
## Quick Start

在项目中引入openapiv2

```go
import "github.com/go-kratos/swagger-api/openapiv2"

h := openapiv2.NewHandler()
//将/q/路由放在最前匹配
httpSrv.HandlePrefix("/q/", h)
```
启动应用后,在浏览器中输入 [http://\<ip>:\<port>/q/services](http://ip:port/q/services),找到需要渲染的\<package_name>.\<service_name>
![Alt text](/img/services.png)
在浏览器中输入[http://\<ip>:\<port>/q/swagger-ui/](http://\<ip>:\<port>/q/swagger-ui/),同时在Swagger ui界面的Explore栏目中输入[http://\<ip>:\<port>/q/service/\<package_name>.\<service_name>](http://<ip>:<port>/q/service/\<package_name>.\<service_name>)并点击Explore
![Alt text](/img/swagger.png)

0 comments on commit c12752f

Please sign in to comment.