2017 © Pedro Peláez
 

symfony-bundle swagger-bundle

Symfony 2 bundle for leveraging swagger library test/mock API contracts

image

epfremme/swagger-bundle

Symfony 2 bundle for leveraging swagger library test/mock API contracts

  • Tuesday, February 7, 2017
  • by epfremmer
  • Repository
  • 1 Watchers
  • 0 Stars
  • 824 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 1 Forks
  • 2 Open issues
  • 11 Versions
  • 3 % Grown

The README.md

Swagger Bundle

Symfony 2 bundle for leveraging swagger development & testing tools, (*1)

Installation

  • Require package composer require epfremme/swagger-bundle
  • Install packages composer install

Note: This bundle should only be used in dev mode and be included as a dev only dependency. The purpose of these resources are to assist the creation of an API symfony application during development, (*2)

Usage

There are 2 main bundle parameters to you can override in your parameters.yml:, (*3)

  1. swagger_bundle.swagger_file default: Resources/docs/swagger.yaml - specify swagger file
  2. swagger_bundle.mock_api default: true - turn on/off to deactivate the mock API listener

More deatils on each below..., (*4)

Behat Usage

Behat documentation: behat, (*5)

  • Add the SwaggerContext file to your behat.yml config suite(s)

Sample Behat Config

Sample Behat configuration using the SwaggerContext for validating json schemas, (*6)

default:
    suites:
        app:
            paths:
                - %paths.base%/src/AppBundle/Tests/Features/
            contexts:
                - Epfremme\SwaggerBundle\Behat\SwaggerContext: ~
    extensions:
        Behat\Symfony2Extension: ~
        Behat\MinkExtension:
          sessions:
            default:
              symfony2: ~
    testers:
        rerun_cache: .behat_rerun_cache

Context Details

@Given I have the request payload:

Takes in a TableNode for key value pairs to be used as request payload, (*7)

Format: | key | value |, (*8)

@When I request :path

@When I request :path with method :method

Make a request to the API with or without a request method (defaults to GET), (*9)

@When I use the :schema schema

@When I am using the :schema schema

Store a swagger definition schema from your swagger doc to be used to validate API json response data, (*10)

Note: The swagger documentation used is the file defined in the swagger_bundle.swagger_file parameter, (*11)

@When I test swagger path :path

@When I test swagger path :path with operation :operation

@When I test swagger path :path with operation :operation and response :response

Store a swagger response schema from your swagger doc to be used to validate API json response data, (*12)

Note: The swagger documentation used is the file defined in the swagger_bundle.swagger_file parameter, (*13)

@Then the response should be json

Assert the the response is json, (*14)

@Then the response json should contain key :key

Assert that the response json contains "key", (*15)

@Then the response json key :key should equal :value

Assert the response json key equals "value", (*16)

@Then The json response data should be valid

@Then The json response key :key should be valid

Validates the response data agains the previously specified swagger definition or response schema, (*17)

Mock API Usage

The mock API can be disabled by setting swagger_bundle.mock_api to false. Also note the listener will not run in prod mode if you forget to move it to require-dev or added it to the wrong are of your kernel, (*18)

  1. Install app/console swagger:install:mock-api
  2. Add the x-mock-api header to the request to trigger the listener to trigger the mock response

Resources

A useful chrome extension used to mock request headers Modheader, (*19)

Additional chance methods & options that can be defined in the swagger.json doc chance, (*20)

The Versions

07/02 2017

dev-master

9999999-dev

Symfony 2 bundle for leveraging swagger library test/mock API contracts

  Sources   Download

MIT

The Requires

 

by Edward Pfremmer

02/05 2016

v1.0.2

1.0.2.0

Symfony 2 bundle for leveraging swagger library test/mock API contracts

  Sources   Download

Nerdery

The Requires

 

The Development Requires

by Edward Pfremmer

02/05 2016

v1.0.1

1.0.1.0

Symfony 2 bundle for leveraging swagger library test/mock API contracts

  Sources   Download

Nerdery

The Requires

 

The Development Requires

by Edward Pfremmer

27/02 2016

v1.0.0

1.0.0.0

Symfony 2 bundle for leveraging swagger library test/mock API contracts

  Sources   Download

Nerdery

The Requires

 

The Development Requires

by Edward Pfremmer

23/02 2016

v0.1.6

0.1.6.0

Symfony 2 bundle for leveraging swagger library to generate application code

  Sources   Download

Nerdery

The Requires

 

The Development Requires

by Edward Pfremmer

06/07 2015

v0.1.5

0.1.5.0

Symfony 2 bundle for leveraging swagger library to generate application code

  Sources   Download

Nerdery

The Requires

 

The Development Requires

by Edward Pfremmer

05/07 2015

v0.1.4

0.1.4.0

Symfony 2 bundle for leveraging swagger library to generate application code

  Sources   Download

Nerdery

The Requires

 

The Development Requires

by Edward Pfremmer

03/07 2015

v0.1.3

0.1.3.0

Symfony 2 bundle for leveraging swagger library to generate application code

  Sources   Download

Nerdery

The Requires

 

The Development Requires

by Edward Pfremmer

03/07 2015

v0.1.2

0.1.2.0

Symfony 2 bundle for leveraging swagger library to generate application code

  Sources   Download

Nerdery

The Requires

 

The Development Requires

by Edward Pfremmer

03/07 2015

v0.1.1

0.1.1.0

Symfony 2 bundle for leveraging swagger library to generate application code

  Sources   Download

Nerdery

The Requires

 

The Development Requires

by Edward Pfremmer

03/07 2015

v0.1.0

0.1.0.0

Symfony 2 bundle for leveraging swagger library to generate application code

  Sources   Download

Nerdery

The Requires

 

The Development Requires

by Edward Pfremmer