@axway/api-builder-plugin-ft-oas

Adapts Open API Specification (OAS) 2.x and 3.x files to API Builder flow-triggers.

Usage no npm install needed!

<script type="module">
  import axwayApiBuilderPluginFtOas from 'https://cdn.skypack.dev/@axway/api-builder-plugin-ft-oas';
</script>

README

@axway/api-builder-plugin-ft-oas

This is a plugin for API Builder that provides a OpenAPI flow-trigger for providing a pluggable interface that can be used to provide an API First experience with an OpenAPI 2 or OpenAPI 3 specifications, that can be used to bind operations to Flows.

Installation

You can install this plugin into an existing API Builder project. Follow the Getting Started Guide to create an API Builder service if you do not already have one.

npm install @axway/api-builder-plugin-ft-oas

Changes

0.10.0

  • 7140: Breaking change: Minimum API Builder version is now Gondar.

  • 7140: Added getOperationId to the spec interface.

0.9.2

  • 7258: Internal refactoring.

0.9.1

  • 7220: Added support for updating a previously imported OpenAPI document.

0.9.0

  • 7168: Added behavior to auto-pick an appropriate content-type response header if not provided by the flow.

  • 7168: Breaking change: If the flow does not set a content-type header, and the OpenAPI document is ambiguous about the response content-type, then the API will return 500.

0.8.0

  • 7212: Breaking change: Sending a body when the OAS definition does not define a requestBody will result in a 400 Bad Request.

  • 7212: Fixed an issue with request processing that can incorrectly treat requests having content-length: 0 as being invalid, even when the body is optional.

0.7.0

  • 7138: Breaking change: Minimum API Builder version is now Flint. Now supports configuration overrides in the OpenAPI 2.0 and 3.0 api-docs when config.overrides are enabled.

0.6.0

  • 7195: Breaking change: Minimum API Builder version is now Flint. Fixed issue handling request body of content-type application/x-www-form-urlencoded or multipart/form-data when dereferencing JSON schema references to parse and validate the request body.

0.5.1

  • 7213: Fixed an issue where a JSON encoded array request body would generate 400 Bad Request.

0.5.0

  • 7166: Breaking change: Minimum API Builder version is now Exeter. Now supports documenting TLS in the OpenAPI 2.0 and 3.0 api-docs when config.ssl is enabled.

0.4.0

  • 7193: Breaking change: Minimum API Builder version is now 4.77.0. Now supports passing XML body to the flow as a string, as opposed to a Buffer, when the request has an "XML" type content-type header (e.g. application/xml).

0.3.2

  • 7199: Update @axway/api-builder-oas-style dependency.

0.3.1

  • 7111: Improved test coverage.

0.3.0

  • 7182: Adds support for requestBody validation.

0.2.5

  • 7153: Support stricter parameter style validation.

0.2.4

  • 7155: Update @axway/api-builder-oas-flow-node dependency.

0.2.3

  • 7135: HTTP response headers are now sent based on the flow HTTP response flow-node.

0.2.2

  • 7142: Changed to bind apidocs on "openapi" instead of "oas", i.e. /apidocs/openapi.yaml and /apidocs/openapi.json.

0.2.1

  • 7123: Update @axway/api-builder-oas-flow-node dependency.

0.2.0

  • 7148: Supports HTTP body parsing and validation for multipart/form-data and application/x-www-form-urlencoded requests.

0.1.0

  • 7136: Added feature to dedupe the configured apiPrefix from paths if they all start with apiPrefix.

0.0.9

  • 7143: Adopted new internal unit-testing framework.