swagger系列三：結合Nginx訪問控制及swagger常見問題解決

王偉廷發布于2019-06-28 18:39 / 1425人閱讀

摘要：再結合模塊來增強安全性。如查看結果基本認證與地址訪問限制相結合。配置重啟訪問不輸入賬戶密碼或賬戶密碼錯誤訪問常見問題右下角錯誤點擊可見解決方法在使用時它會調用一個遠程驗證，在中添加關閉遠程驗證即可。

1. 用HTTP基本身份驗證限制訪問

在swagger生成的文檔放在公網上的時候，就暴露了接口，有了安全隱患。nginx的ngx_http_auth_basic_module模塊為我們提供了方便。再結合Apache模塊htpasswd來增強安全性。需安裝Apache服務，這里不贅述。

htpasswd: htpasswd建立和更新存儲用戶名、密碼的文本文件， 用于對HTTP用戶的basic認證。

創建一個密碼文件和第一個用戶。htpasswd使用該-c標志（創建一個新文件,如果文件存在則不用-c），文件路徑名作為第一個參數，并將用戶名作為第二個參數運行該實用程序,按Enter并在提示中輸入user1的密碼。如：
$ sudo htpasswd -c /etc/apache2/.htpasswd user1

查看結果：
$ cat /etc/apache2/.htpasswd
user1：$ APR1 $ / woC1jnP $ KAh0SsVn5qeSMjTtn0E9Q0
user2：$ APR1 $ QdR8fNLT $ vbCEEzDj7LyqCMyNpSoBh /

基本認證與IP地址訪問限制相結合。配置Nginx：

 location /docs {
              satisfy all; 
             
              deny  192.168.31.2; 
              allow 192.168.31.0/24;
              allow 127.0.0.1;
              deny  all;
              
              auth_basic          "Administrator"s area";
              auth_basic_user_file /usr/local/etc/nginx/.htpasswd;
          }

重啟Nginx： nginx -s reload,訪問

不輸入賬戶密碼或賬戶密碼錯誤訪問：

2.常見問題

右下角 ERR 錯誤

點擊可見

{"schemaValidationMessages":[{"level":"error","message":"Can"t read from file swagger.json"}]}

解決方法：在使用swagger-ui時它會調用一個遠程驗證，在index.html中添加 validatorUrl:false關閉遠程驗證即可。

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/28497.html

Swagger 生成 PHP restful API 接口文檔

摘要：需求和背景需求為客戶端同事寫接口文檔的各位后端同學已經在各種場合回憶了使用自動化文檔工具前手寫文檔的血淚史我的故事卻又不同因為首先來說我在公司是組負責人屬于上述血淚史中催死人不償命的客戶端陣營但血淚史卻是相通的沒有自動化文檔的日子對接口就是需求和背景需求: 為客戶端同事寫接口文檔的各位后端同學,已經在各種場合回憶了使用自動化文檔工具前手寫文檔的血淚史.我的故事卻又不同,因為首先來說...

xiaotianyi 2019-06-28 18:43 評論0 收藏0
自動化代碼生成工具 Snips 開發實踐

摘要：今天我來和大家分享一下以及自動化生成工具的開發經驗。代碼生成工具接著講講代碼生成工具，對于來講，有官方的代碼生成器，還有其他的同類開源項目比如。現有的代碼生成器沒有可以開箱即用的，都需要去進行不少的修改。前言在開發工作中，經常會遇到新產品、服務上線后，需要將其 API 編寫不同語言的 SDK。但不同語言 SDK 中都有很大一部分內容是用來進行 API 的描述，而且這部分代碼量是最大...

only_do 2019-08-21 11:20 評論0 收藏0
自動化代碼生成工具 Snips 開發實踐

摘要：今天我來和大家分享一下以及自動化生成工具的開發經驗。代碼生成工具接著講講代碼生成工具，對于來講，有官方的代碼生成器，還有其他的同類開源項目比如。現有的代碼生成器沒有可以開箱即用的，都需要去進行不少的修改。前言在開發工作中，經常會遇到新產品、服務上線后，需要將其 API 編寫不同語言的 SDK。但不同語言 SDK 中都有很大一部分內容是用來進行 API 的描述，而且這部分代碼量是最大...

qc1iu 2019-07-25 11:14 評論0 收藏0
自動化代碼生成工具 Snips 開發實踐

摘要：今天我來和大家分享一下以及自動化生成工具的開發經驗。代碼生成工具接著講講代碼生成工具，對于來講，有官方的代碼生成器，還有其他的同類開源項目比如。現有的代碼生成器沒有可以開箱即用的，都需要去進行不少的修改。前言在開發工作中，經常會遇到新產品、服務上線后，需要將其 API 編寫不同語言的 SDK。但不同語言 SDK 中都有很大一部分內容是用來進行 API 的描述，而且這部分代碼量是最大...

pepperwang 2019-06-27 15:06 評論0 收藏0
Spring Swagger在nginx 二級url 無法正常使用修改host解決

摘要：解決方法在配置直接設置的就可以了，網上搜索一堆完全沒找到這個問題的解決方案，最后翻了源碼找到方法。二級配置類接口文檔接口文檔問題描述測試環境用了nginx做二級url做映射，但swagger的http://www.xxx.com/二級url/v2...JSON里面的host地址還是一級目錄，不自動對應nginx做了映射的二級url，因此使用swagger-ui.html在線調試AP...

xingqiba 2019-07-25 14:18 評論0 收藏0