Logo: Relish

  1. Sign in

Project: Lurker 1.0.0

Publisher: Vlad Bokov

controller nested schema scaffolding

If your API endpoint has some dynamic segment - Lurker can handle it as well!

Scenarios
scaffold a json schema for a "repos/index" in a nested controller spec
Given
a file named "spec/controllers/api/v1/repos_controller_spec.rb" with: 
describe Api::V1::ReposController, :lurker do
  render_views

  let!(:user) do
    User.where(name: 'razum2um').first_or_create!.tap do |u|
      u.repos.first_or_create!(name: 'lurker')
      u.repos.first_or_create!(name: 'multi_schema')
    end
  end

  it "lists all the repos of the user" do
    # rails 4 doesn't stringify values and schema has integers
    # rails >= 5 have limit as string & proper query_params extension
    get :index, params: { user_id: user.id, limit: 1, format: 'json' }
    expect(response).to be_success
    expect(JSON.parse(response.body).size).to eq 1
  end
end
When
I run bin/rspec spec/controllers/api/v1/repos_controller_spec.rb
Then
the example should pass
Then
a file named "lurker/api/v1/users/__user_id/repos-GET.json.yml" should exist
Then
the file "lurker/api/v1/users/__user_id/repos-GET.json.yml" should contain: 
---
description: repo listing
prefix: repos management
requestParameters:
  description: ''
  type: object
  additionalProperties: false
  required: []
  properties:
    limit:
Then
the file "lurker/api/v1/users/__user_id/repos-GET.json.yml" should contain: 
responseCodes:
- status: 200
  successful: true
  description: ''
responseParameters:
  type: array
  items:
    description: ''
    type: object
    additionalProperties: false
    required: []
    properties:
      id:
        description: ''
        type: integer
        example: 1
      name:
        description: ''
        type: string
        example: lurker
      user_id:
        description: ''
        type: integer
        example: 1
extensions:
  method: GET
  path_info: "/api/v1/users/1/repos.json"
  path_params:
    controller: api/v1/repos
    action: index
    user_id: '1'

Last published about 2 years ago by razum2um.