\n\n## Check out the Demo\n[OpenAPI Explorer Demo](https://authress-engineering.github.io/openapi-explorer/#?route=get-/v1/users/-userId-/resources/-resourceUri-/permissions/-permission-)\n\n(Curious about the [exact styling of the demo](./docs/authress-example.vue))\n\n## Get started now\n`npm install openapi-explorer`\n\n### Quick start example\n* `import 'openapi-explorer';`\n\n```html\n\n
\n
The API
\n
\n\n```\n\n## Features\n- OpenAPI 3.2+\n- Built in automatic Internationalization (I18n)\n- Works with any framework\n- View resources, models, and directly make API calls\n- Better Usability, \n - Request fields are pre-populated with default data\n - Takes only one click to make an API call\n - Renders SDK/client code samples\n - Branding and Personalization features makes it easy to follow any style guide\n - Fully customizable theme\n- Plenty of customization options \n - Add external contents throughout the component, extensible with markdown, images, links, and text\n - All properties are reactive\n - Style the element with standard css (change padding, position, border, margin )\n - Styles that reflect your site and your UI/UX frameworks (React, Vue, vanilla js, Bootstrap, Material, and many more...)\n- Responsive so it works on mobile\n- Lightweight and fast\n\n\n## Documentation\n* [Migrating from v1 to v2 of openapi-explorer](./CHANGELOG.md#2.0) - Review the breaking changes\n* [Property and variables documentation](./docs/documentation.md)\n* [Examples (Vue, React, JS, and more)](./docs/examples.md)\n* Generate the open specification document necessary for this library - by using an editor or by following the [Open API Specification](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.2.0.md)\n* [Styling your openapi-explorer UI](./docs/styling.md)\n* [Recent changes and updates](./CHANGELOG.md)\n\n## Troubleshooting integration issues\n[Common issues](./docs/troubleshooting.md)\n\n\n## Contribution\n[Contributions Guide](./CONTRIBUTING.md)\n\n```bash\n# Clone / Download the project then\ngit clone\n\n## Pull in dependencies\nyarn\n\n# build will generate dist/openapi-explorer.min.js\nyarn build \n\nimport 'openapi-explorer';\n```\n\n\n## Copyright\nCopyright Rhosys AG\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this repository source except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n","readmeFilename":"README.md"}
![](\"https://img.shields.io/static/v1?label=Authress+Engineering&message=OpenAPI%20Explorer&color=%23FBAF0B&logo=androidauto&logoColor=%23FBAF0B\")
\n \n ![](\"https://img.shields.io/badge/license-Apache%202.0-blue.svg\"){kind=icon}
\n \n ![](\"https://badge.fury.io/js/openapi-explorer.svg\"){kind=icon}
\n \n ![](\"https://img.shields.io/badge/community-Discord-purple.svg\"){kind=icon}
\n \n ![](\"https://img.shields.io/badge/webcomponents.org-OpenAPI%20Explorer-blue.svg?style=social\"){kind=icon}
\n![\"Desktop](\"./docs/desktop-view.png\")
\n \n