Skip to content

Latest commit

 

History

History
107 lines (61 loc) · 4.92 KB

README.md

File metadata and controls

107 lines (61 loc) · 4.92 KB
Raw

OpenAPIClientWizard(beta- no production ready)

Welcome to OpenAPIClientWizard – the ultimate plugin for RAD Studio that revolutionizes the way Delphi developers implement REST API clients.

Overview

As Delphi developers, we often face the challenge of implementing REST API clients. API documentation rarely includes Delphi code snippets, forcing us to read the documentation and implement each method - GET, POST, PUT, DELETE - manually. Even with Swagger or OpenAPI specifications, it's a time-consuming process. Without these specifications, we resort to tools like Delphi's REST Debugger or Postman, testing each method individually before coding them into our projects.

OpenAPIClientWizard changes all that. This powerful plugin reads Swagger, OpenAPI specifications, or Postman collection and generates a fully implemented client-side sample(VCL) project in Delphi, ready to compile, in just 2-3 seconds!

IDE Version support

  • Supports from Delphi 10.1 Berlin to 12.x Athens

Features

  • Supports Swagger Specifications: Handles JSON format effortlessly.
  • Supports OpenAPI Specifications: Handles both JSON and YAML formats effortlessly.
  • Postman Collection Conversion: Converts Postman collections into complete Delphi client projects.
  • Rapid Project Generation: Generates fully implemented client-side projects in seconds, saving you a huge time(weeks of development).

Benefits

  • Save Time: Reduces weeks of work to mere seconds.
  • Increase Productivity: Focus on building amazing applications instead of spending time on repetitive coding tasks.
  • Simplify Development: Automate the creation of Delphi client-side projects from API specifications.

Getting Started

  1. Download and Install: Follow the installation instructions in the repository.
  2. Run OpenAPIClientWizard: Open your RAD Studio IDE and run the plugin.
  3. Create a new project in RAD Studio by following this path: File/New/Other:

image

  1. Setup the project's preferences

image

  1. Generate Your Project: Provide your Swagger or OpenAPI specification, or Postman collection, and let the plugin do the rest.

image

Remarks

To download, you must provide the direct URL of the file; redirection is not supported. You cannot use the first URL to download the JSON specification, but the second one is acceptable.

1- https://github.com/adewg/ICAR/blob/ADE-1/url-schemes/reproductionURLScheme.json ❌

2- https://raw.githubusercontent.com/adewg/ICAR/ADE-1/url-schemes/reproductionURLScheme.json ✅

Demo Video

Watch a short video here: to learn how to use the plug-in (or click on the below image👇👇)

Support

If you find OpenAPIClientWizard useful, please give it a star.

Your support is greatly appreciated!

You can also support my work by buying me a coffee. This helps me continue developing this plugin and other tools like ChatGPTWizard and EasyDBMigrator.

Buy Me A Coffee

Ask for direct support or specific implementation

OpenAPIClientWizard is provided as is. If you need any specific implementation contact me via email, please.

Contributing

Contributions are welcome! If you have suggestions for improvements or find any issues, please open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Dependencies

This plugin utilizes the Neslib library to parse Yaml format, which is included in the repository for convenience.

No action is required on your part.

However, you can find the latest source here.

Transform the way you develop REST API clients in Delphi with OpenAPIClientWizard.

Download it today and streamline your workflow!

Delphi

Made with ❤️ on Delphi