Releases: mulesoft/api-console
Releases · mulesoft/api-console
v6.0.1
v6.0.0
- Upgrade to final web components specification: replacing HTML imports with JavaScript modules
- Replacing Polymer with super lightweight, almost native,
LitElement. This triggers a series of changes:- All dash-case attributes are now "no-dash", lowercase, web style attributes. For example old
redirect-uriis nowredirecturi. This is true for all properties used as HTML attribute. Properties names are the same. - New templating engine. API Console now uses
lit-htmlwhich is performant HTML templating system. - Build process is completely different. See documentation at https://docs.api-console.io.
- All dash-case attributes are now "no-dash", lowercase, web style attributes. For example old
- Redesigned base input controls. API console now uses own, material design based, basic UI input controls. It comes with 3 predefined styles:
- Default - Material design filled style
- Outlined - Material design outlined state controlled by
outlinedattribute - Anypoint - Compatibility layer with the Anypoint platform. Controlled by
compatibilityattribute
- The request panel (aka try it) now only renders editors that corresponds to the API data model. This means that, for example, if headers are not defined for given operation then headers panel is not rendered.
- Dropped support for tabs view for the editors in the request panel and they are stacked now.
- Code mirror dependency requires some additional libraries that won't work inside JavaScript module. This means that those libraries have to be included into the web application before initializing the element. See the documentation or readme file for details.
- API Console is now WCAG compliant. All components used to build the console passed axe-core tests and therefore are fully accessible.
- The application and the component are now split into separate components. Use
api-consolecustom element for embedding the console inside existing web application andapi-console-appto create stand alone application. - New demo pages. Preview the console with
npm startcommand (run inside cloned repository) to see API console with various scenarios and configuration options. - Removed any reference to CSS mixins (the
@applyfunction). All styling options are now defined via CSS variables. Any styles defined for previous version of API console won't work. - Minimised use of icons in favour of regular buttons with labels.
- This release contains tones of bug fixes and improvements reported by the community and our customers ❤
- The Chrome proxy extension banner is not rendered by default. Set
allowExtensionBannerproperty to initialize the console with the extension support. - Added configuration option to set a static OAuth 2 client ID and secret for the application. This way it is easier to demo an API by providing demo client id.
- Added markdown sanitization
- Now XML schemas and examples are propertly rendered.
- Huge XML schemas are now not syntax highlighted (above 10K characters) as it causes the browser to hang.
- XML examples are now properly formatted and RAML type name is properly resolved (instead of
<model>element)
v3.0.34
New headers for mocking service requests
v3.0.33
Bug fixing.
v5.0.2
The release contains several bug fixes and improvements:
- Updated AMF parser version and support for new model structure
- Fixed examples rendering in the type documentation
- Now type documentation renders generated JSON/XML schema when RAML's
mediaTypes/ OAS'producesproperty is set - Examples now have default values for boolean, number, and null values when default value and example is missing.
v3.0.32
v5.0.1
v6.0.0-preview.1
Preview of ES6 modules version of API Console.
This is early preview, not targeted for production.
Try it and give us your feedback.
v5.0.0
Next release of API Console version 5!
- New: Support for AMF data model instead of RAML parser allows to render a documentation for RAML and OAS specification and enables the console to read even more API types
- New: Users can now define new properties (headers, query parameters) in the request editor that are not defined in the API spec.
- Update: API console now works with web components specification version 1. This allows to target all browsers with native support for web components spec and those with polyfill support.
- New: Build process to create separate bundles for ES5 and ES6 enabled browsers so modern browsers can run the console with minimal required setup
- Update: Redesigned styling API to enable consumers to apply corporate theme using CSS variables
- Update: Build tools for the console now are based on AMF library to generate new data model
- Fix: Feedback from our customers and the open source community was applied to this version resolving tens of issues regarding performance, stability and design
- Update: Redesign of the documentation part to deliver best in class documentation tool for APIs
- Update: Redesign of navigation for faster recognition of the API structure and to search for an endpoint
- New: Added documentation for security schemes
- New: Added code examples in the method documentation
- Update: Updated how union types are rendered - now it renders type name in the type selector instead of “Variant”
v5.0.0-rc.2
Fixing CORS extension banner behavior.