ditkrg/jsonapi-swagger
4
0
Fork 0
mirror of https://github.com/ditkrg/jsonapi-swagger.git synced 2026-01-22 22:06:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

update README.md

Browse Source
This commit is contained in:
YingRui Lu 2019-06-19 14:24:20 +08:00
parent a5fe2f7fdc
commit 288f9f89cd
1 changed files with 25 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@ -25,8 +25,31 @@ Or install it yourself as:
## Usage
1. config jsonapi swagger
```rb
# config/initializers/swagger.rb
Jsonapi::Swagger.config do |config|
config.use_rswag = false
config.version = '2.0'
config.info = { title: 'API V1', version: 'V1'}
config.file_path = 'v1/swagger.json'
end
```
2. generate swagger.json
```sh
rails generate jsonapi:swagger User # UserResponse < JSONAPI::Resource
# gen swagger/v1/swagger.json
bundle exec rails generate jsonapi:swagger User # UserResponse < JSONAPI::Resource
```
3. additional
use `rswag`, have to run
```sh
# gen swagger/v1/swagger.json
bundle exec rails rswag:specs:swaggerize
```
## RoadMap
@ -34,7 +57,7 @@ rails generate jsonapi:swagger User # UserResponse < JSONAPI::Resource
- [x] immutable resources
- [x] filter/sort resources
- [x] mutable resources
- [ ] generate swagger.json without rswag
- [x] generate swagger.json without rswag
## Resource