diff --git a/README.md b/README.md index 16504adaa..f55a68456 100644 --- a/README.md +++ b/README.md @@ -18,8 +18,8 @@ https://pig4cloud.com - 完整的oAuth 流程,资源服务器控制权限 - 去除了部分对于开发不友好的中间件 -### 部署说明 -[部署说明](doc/deploy.md) +### 使用说明 +[目录](doc/md/catalog.md) ## 协议和授权 diff --git a/doc/md/catalog.md b/doc/md/catalog.md new file mode 100644 index 000000000..263a9588f --- /dev/null +++ b/doc/md/catalog.md @@ -0,0 +1,2 @@ +[部署说明](deploy.md) +[swagger使用](swagger.md) diff --git a/doc/deploy.md b/doc/md/deploy.md similarity index 100% rename from doc/deploy.md rename to doc/md/deploy.md diff --git a/doc/md/swagger.md b/doc/md/swagger.md new file mode 100644 index 000000000..5330883fb --- /dev/null +++ b/doc/md/swagger.md @@ -0,0 +1,58 @@ +# 如何在pigx Swagger中OAuth2.0 授权 + +## 增加客户端 + +默认对所有终端进行验证码校验,但是swagger 模拟的时候不需要。 + +- 通过界面的形式 + + ![](http://obq1lvsd9.bkt.clouddn.com/20180725132807.png) + +- 直接操作**sys_oauth_client_details**表 + +```sql +INSERT INTO `pigx`.`sys_oauth_client_details` ( + `authorities`, + `authorized_grant_types`, + `web_server_redirect_uri`, + `scope`, + `additional_information`, + `autoapprove`, + `resource_ids`, + `refresh_token_validity`, + `client_secret`, + `client_id`, + `access_token_validity` +) +VALUES + ( + NULL, + 'password,refresh_token', + NULL, + 'server', + NULL, + 'true', + NULL, + NULL, + 'test', + 'test', + NULL + ); +``` + +## 过滤指定客户端 + +pigx-gateway-dev.yml + +```yml +# 不校验验证码终端 +ignore: + clients: + - test +``` + +## 填写客户端信息 + +![](http://obq1lvsd9.bkt.clouddn.com/20180725133119.png) + +![](http://obq1lvsd9.bkt.clouddn.com/20180725133206.png) \ No newline at end of file