Unmock OpenAPI builder

Web extension for building OpenAPI specifications. Runs in Chrome and Firefox.

⚠️ This web extension is using an outdated version of Unmock. If you'd be interested in helping us update this, please check out this open issue.

Made with ❤️ by unmock.

Description

Are you a developer using third-party APIs? Easily create formal OpenAPI specification from API documentation in browser to:

• write better tests
• automatically generate client code
• migrate legacy documentation to documentation autogenerated from OpenAPI specification

Extension does not send your data anywhere and is fully open-source: https://github.com/unmock/unmock-webextension

Features

• Smartly parse OpenAPI specification from written documentation
• Use Swagger editor in-browser to fill in the missing parts

Note that the smart parser is in early-stage development. We welcome contributions and feature requests at https://github.com/meeshkan/unmock-webextension/issues.

Get started

• Install extension
• Open a page containing written API documentation, for example, https://docs.readthedocs.io/en/stable/api/v2.html
• Extension icon should light up with a badge. Open Swagger editor from the pop-up window to autogenerate specification template.
• Fill in the missing parts
• Export the finished specification

Get in touch

• Learn more about unmock, your favorite tool for developing apps with third-party APIs: https://unmock.io/

• Email us: dev@meeshkan.com

• Find us in Medium: https://medium.com/@meeshkan

• Tweet @MeeshkanML

• Add issues, feature requests and pull requests in GitHub: https://github.com/meeshkan/unmock-webextension

• Learn more about Swagger editor: https://github.com/swagger-api/swagger-editor

Development

Install dependencies:

$ yarn

Create production build in build/ directory:

$ yarn build

Run webpack development server with hot reloading:

$ yarn start

Testing in Chrome

1. Open the Extension Management page by navigating to chrome://extensions.
2. Enable Developer Mode by clicking the toggle switch next to Developer mode.
3. Click the Load unpacked button and select build/ directory.

Testing in Firefox

Follow the instructions here, choosing manifest.json from build/ directory.

Contributing

Thanks for wanting to contribute! We'll soon have a contributing page detaling how you can get involved. Meanwhile, feel free to star this repository, open issues and ask for more features and support.

Please note that this repository is governed by the Meeshkan Community Code of Conduct. By participating, you agree to abide by its terms.

License

MIT

Copyright (c) 2018–2019 Meeshkan and other contributors.

This project acknowledges code from the open-source projects below.

Swagger editor

Copyright (c) 2018 SmartBear Software.

Chrome webextension boilerplate

Copyright (c) 2016 Samuel Simões.