Skip to content

Now Available: API Console v4.0
Compare
Choose a tag to compare
@sichvoge sichvoge released this 27 Jun 17:02
· 482 commits to master since this release
v4.0.0
c74eacd

I am excited to announce a new version of the API Console. The 4.0 release comes with a completely new and responsive UI, improved capabilities for trying out your API, and additional tools to integrate automated builds into your CI/CD pipeline.

Resolved Issues

  • Fixed an issue where the console did not render an example that has additional facets (e.g. displayName) where the instance is defined inside the “value” facet.
  • Fixed an issue where some HTTP status codes and its content are not rendered by the console when defined inside a security scheme.
  • Fixed an issue where the API console was unable to display JSON schemas that contain patterns that include the pipe character.
  • Fixed an issue where boolean inputs are rendered as ‘false’, but they were resolved to ‘true’ when making a request from the TryIt view.
  • Optional parameters are not shown in the URL inside the TryIt view anymore.
  • All type information from multiple libraries are shown now.
  • Array types are rendered correctly now.
  • Default values for ‘baseUriParameters’ are shown in the input fields inside the TryIt view now.
  • Fixed an issue where the security schemes additional header information disappeared when switching between HTTP verbs.
  • Markdown headers are rendered correctly now.
  • Fixed an issue where optional parameters where required for making requests.
  • Fixed several issues with custom security schemes.
  • Fixed an issue with linking to specific resources or HTTP verbs.

Improvements

  • New and responsive user interface.
  • Change URL inside the TryIt view before sending request.
  • Improved support for security schemes like OAuth 2.0 in TryIt view.
  • Built on top of Web Components which makes the entire API console very flexible.
  • Render dropdown list for enum values in the TryIt view.
  • Render examples inside a type listed in the type section.
  • Contextual documentation for input fields inside the TryIt view.
  • New build tools (e.g. CLI) to make generating the API console much easier.
  • Render ‘displayName’ instead of the resource path if present.

Breaking changes

  • The API console is using Bower as a package manager. It’s not available on npm anymore. Version 3.x will be available on npm.
Assets 2
Loading