基本步驟:
1.安裝所需gem
????在 Gemfile 中添加?grape-swagger?和?grape-swagger-rails?這兩個(gè) gem。
gemfile
(注明版本號(hào))
(grape-swagger-rails是 Swagger UI 的 Rails Engine , 也是必備的組件)
2.創(chuàng)建基本框架
基本框架
application_api.rb?是最底層的,里面放最通用的配置识樱,所以在這里 require 'grape-swagger'捉蚤,這樣不用每次都 require 了
application-api.rb
base_api.rb中掛載其余所有api
add_swagger_documentation中聲明的三個(gè)參數(shù):
(1).api_version 路徑精肃,生成文檔
(2).hide_documentation_path: 隱藏文件路徑
(3).hide_format 去掉url后面的格式后綴(.json)
3.配置Swagger_UI
在config/initializers?目錄下添加?swagger.rb?文件
在route中聲明?apidoc 的路徑
最后通過(guò)localhost:3000/apidoc訪(fǎng)問(wèn)api文檔妄呕。