https://github.com/la-rebelion/apicove-tools
APICove Tools is a collection of tools to help you build faster and smarter
https://github.com/la-rebelion/apicove-tools
api-development api-first json-converter json-schema oas3 openapi swagger-codegen swagger2
Last synced: about 2 months ago
JSON representation
APICove Tools is a collection of tools to help you build faster and smarter
- Host: GitHub
- URL: https://github.com/la-rebelion/apicove-tools
- Owner: la-rebelion
- License: mit
- Created: 2024-04-14T01:13:51.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-05T21:58:28.000Z (about 1 year ago)
- Last Synced: 2025-02-10T22:45:46.991Z (4 months ago)
- Topics: api-development, api-first, json-converter, json-schema, oas3, openapi, swagger-codegen, swagger2
- Language: TypeScript
- Homepage: http://tools.apicove.com/
- Size: 3.96 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Converter API to TypeScript
Bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
## Description
This project provides a utility to convert Swagger API specifications into Mocha, Jest test
suites and Strapi (future). The converter focuses on Swagger files that have
**tags in their endpoints**. Only the tags in the Swagger Object (root document object
for the API specification) are considered.
## Dependencies
The following dependencies are used in the project:
- [Swagger-Converter](https://github.com/la-rebelion/swagger-converter/pkgs/npm/swagger-converter): Used to convert Swagger 2.0 to Jest and Strapi.
The converter is a library by "la-rebelion" that is used in this project. The library is not
published to npm, so it is included as a git submodule in the project, but it **is not included**.
Subscribe to the "la-rebelion" community or contact me if you are interested in using the library.
### Deployment
GitHub Pages is used to deploy the app. The app is deployed to the following URL: [https://tools.apicove.com](https://tools.apicove.com)
To deploy the app, run the following command:
```bash
USE_SSH=true yarn deploy
```
## Future Work
The following features are planned for the future:
- [ ] Convert Swagger to Strapi
- [ ] Feature flags to enable/disable features
- [ ] Allow the developer to select the test framework (Jest, Mocha)
- [ ] Generate the code for direct API calls using Fetch, or generate the code using API helpers (developed by the end user/developer)
- [ ] Allow the developer to select the test runner (**Node**, Browser) for the generated code.
- [ ] In Browser Mocha is used, requires to remove the import statements from the boilerplate code.
- [ ] Karma test runner? Does the community still use it, require it, and is it worth it?
Would you like to contribute with ideas or feature requests? Please open a [discussion](https://github.com/la-rebelion/apicove-tools/discussions/new?category=ideas) in the repository.
Do you have a bug to report? Please open an [issue](https://github.com/la-rebelion/apicove-tools/issues/new/choose) in the repository.
## License
MIT License
## Author
[La Rebelion Labs](https://rebelion.la)
## Contributors
- [La Rebelion Labs](https://rebelion.la)
- [Adrian Escutia](https://linkedin.com/in/adrian-escutia)