Skip to content

Latest commit

 

History

History
278 lines (191 loc) · 9.08 KB

README.md

File metadata and controls

278 lines (191 loc) · 9.08 KB
Raw

OpenAPI Governor

Enforce rules against OpenAPI specifications.

$ governor -s ./petstore_v2.yaml -p ./petstore_v1.yaml -r ./ruleset.yaml

Passed (1):
✅   check-value: value at: $.info.title == Swagger Petstore

Failed (2):
❌   required-parameters-added: Required parameter 'category' in GET /pets: new in latest version
❌   check-value: mismatched value at: $.info.location - expected exists, actual: null
  • compare between different schema document versions to check for compatibility differences
  • ensure certain values are always populated in your OpenAPI specifications to enforce your documentation standards
  • also supports a simple accept/approve workflow using git

Backwards compatibility checking

Say you have added a new, required, parameter named category in the latest version of your OpenAPI specification. Knowing this might be important to help you avoid backwards compatibility issues as you roll out your new API version.

When you run Governor, passing the path of the previous and latest versions of your OpenAPI specifications, the required-parameters-added rule will pick this up:

$ governor -s ./petstore_v2.yaml -p ./petstore_v1.yaml -r ./ruleset.yaml

❌   required-parameters-added: Required parameter 'category' in GET /pets: new in latest version

This check works for the following scenarios:

  • an existing parameter is made required (i.e. newly mandatory)
  • a new parameter is added, and marked as required
  • a new path or operation is added containing required parameters

Here is the configuration:

# ruleset.yaml
rules:
  # check if there are newly required parameters
  - required-parameters-added

That's it! 🥳

There is also a similar rule to check for breaking changes in your schema, such as the introduction of a new mandatory property:

# ruleset.yaml
rules:
  # check if there are newly required properties
  - required-properties-added

This is just the start. There is much more you can do with Governor beyond backwards compatibility checking.

Flexible rules

In addition to the required-parameters-added and required-properties-added rules, you can set a variety of other rules for your OpenAPI specifications. For example, you can require certain fields are populated, or match a particular value.

# ruleset.yaml
rules:
  # ensure the title matches the expected value
  - check-value:
      at: $.info.title
      operator: EqualTo
      value: Swagger Petstore

  # ensure the location is not blank
  - check-value:
      at: $.info.location
      operator: Exists

The check-value rule supports the following operators:

  • Exists
  • NotExists
  • Blank
  • NotBlank
  • EqualTo
  • NotEqualTo
  • Contains
  • NotContains

Quick start

The examples directory contains sample OpenAPI specifications and rules.

If you have Docker installed, use the convenience script that wraps the Docker image build, then starts a container passing through arguments.

Prerequisites:

  • JDK 8 or newer
  • Docker

Usage:

./governor.sh [args]

See below for list of valid arguments.

Example:

$ ./governor.sh -s ./examples/petstore_v2.yaml -p ./examples/petstore_v1.yaml -r ./examples/ruleset.yaml

WARN  RuleEnforcer - Some rules failed.

Failed (2):
❌   required-parameters-added: Required parameter 'category' in GET /pets: new in latest version
❌   check-value: mismatched value at: $.info.location - expected exists, actual: null

Passed (1):
✅   check-value: value at: $.info.title == Swagger Petstore

Running Governor

Governor images are pushed to Docker Hub.

See the examples directory in this repository for sample files.

Let's start with the following file structure:

examples/
 ∟ petstore_v1.yaml
 ∟ ruleset.yaml

In this example, petstore_v1.yaml is your OpenAPI specification. The ruleset.yaml file lists the rules you want to enforce against your specification.

Here's an example ruleset:

# ruleset.yaml
rules:
  # ensure the title matches the expected value
  - check-value:
      at: $.info.title
      operator: EqualTo
      value: Swagger Petstore

  # ensure the location is not blank
  - check-value:
      at: $.info.location
      operator: Exists

Run Governor as follows:

docker run --rm -it -v $PWD/examples:/app/examples outofcoffee/governor \
            -s ./examples/petstore_v1.yaml \
            -r ./examples/ruleset.yaml

Note that this uses the bind-mount mechanism in Docker. Therefore, the ./examples prefix for the files refers to the path /app/examples within the container filesystem.

Comparing between versions

Some rules allow you to check for differences between specification versions. For example, you may have modified your specification to introduce a new mandatory parameter. Knowing this might be important to help you avoid backwards compatibility issues as you roll out your new API version.

Let's add a second version of our OpenAPI specification, petstore_v2.yaml. For the purposes of this example, let's add a new, required, parameter to v2 of the specification. This results in the following file structure:

examples/
 ∟ petstore_v1.yaml
 ∟ petstore_v2.yaml
 ∟ ruleset.yaml

Now add the following rule to our ruleset file:

  # check if there are newly required parameters
  - required-parameters-added

Run Governor as follows - note the use of the -p (previous version) flag:

docker run --rm -it -v $PWD/examples:/app/examples outofcoffee/governor \
            -s ./examples/petstore_v2.yaml -p ./examples/petstore_v1.yaml \
            -r ./examples/ruleset.yaml

As there is a new mandatory ('required') parameter between v1 and v2 of the specification, the required-parameters-added rule will pick this up.

Filters: skipping rules or results

You can ignore/skip differences using filters. This can be handy if you want to mark certain changes as accepted, or mitigated.

Skipped results are reported at DEBUG log level:

DEBUG RuleEnforcer - Skipped results (2):
⚪   required-parameters-added: Required parameter 'size' in GET /pets: new in latest version
⚪   required-properties-added: Required property 'colour' in /pets request (application/json): changed to be required in latest version

You can provide filters using a filters file. Here's an example:

# filters.yaml
filters:
  # ignore the license name
  - ignore-value:
      at: $.info.license.name

  # ignore changes to the pets request size parameter
  - ignore-parameter:
      path: /pets
      operation: GET
      parameter: size

  # ignore changes to the pets response colour property
  - ignore-property:
      path: /pets
      contentType: application/json
      property: colour

Run Governor as follows - note the use of the -f (filters file) flag:

docker run --rm -it -v $PWD/examples:/app/examples outofcoffee/governor \
            -s ./examples/petstore_v2.yaml -p ./examples/petstore_v1.yaml \
            -r ./examples/ruleset.yaml \
            -f ./examples/filters.yaml

Filters always take precedence over rules. For example, if we had a rule checking the value $.info.license.name, the filter configuration above would cause it to be skipped.

Usage

Usage: governor options_list
Options: 
    --currentSpecFile, -s -> OpenAPI specification file (always required) { String }
    --previousSpecFile, -p -> Previous OpenAPI specification file { String }
    --rulesFile, -r -> Rules file (always required) { String }
    --filterFile, -f -> Filters file { String }
    --verboseExitCode, -x -> Return a non-zero exit code if rule evaluation fails
    --help, -h -> Usage info

Exit code

When Governor runs, it produces output indicating which rules pass and fail. By default, it will exit with status 0. If you'd like the exit code to reflect whether all rules were evaluated successfully, pass the -x flag. In this case, if all rules pass, the exit code will be 0, otherwise it will be 1.

This can be useful when scripting your CI/CD pipeline to cause a build or deployment to fail if rules are not satisfied.

Building

If you don't want to use the prebuilt Docker image, you can build Governor yourself.

With Docker

This method builds a Docker image, named outofcoffee/governor:latest. You can then bind-mount a directory containing your specifications, use it as a base image etc.

Build:

./gradlew dockerBuildImage

Test:

docker run --rm -it -v $PWD/examples:/app/examples outofcoffee/governor:latest \
        -s ./examples/petstore_v2.yaml -p ./examples/petstore_v1.yaml \
        -r ./examples/ruleset.yaml \
        -f ./examples/filters.yaml

Without Docker

This method builds an application distributable, with entrypoint scripts for *NIX and Windows, under the build/install/openapi-governor/bin directory.

Build:

./gradlew installDist

Test:

./build/install/openapi-governor/bin/openapi-governor \
        -s ./examples/petstore_v2.yaml -p ./examples/petstore_v1.yaml \
        -r ./examples/ruleset.yaml \
        -f ./examples/filters.yaml