SOAJS Swagger Editor

Introduction

The following space introduces the new Swagger Editor by SOAJS. It is very similar to the well-known Swagger Editor but it's made on top of AngularJs.

The power of SOAJS Swagger Editor is that you can create a microservice by simply writing the documentation of its APIs and couple of essential information (name, port, version, etc....).

This documentation will be reverse engineered and transformed to a configuration file that follows the SOAJS standards along with a fully functional REST layer to deploy the microservice.

In other words, you will write the APIs documentation, click generate and you will get a ready to use microservice.

Benefits & Features

Standardization :

Not all developers work or produce deliverables the same way. No need to worry about how the code will be handed by your team and how to integrate the different microservices produced.
We standardized all the input/output and integration you might come across when building microservices, the only customization is the actual business logic.
Swagger Editor in SOAJS, performs a reverse engineering mechanism that reads the Yaml documentation you give it and generates:

  1. Configuration file containing your APIs and IMFV and ready to be used
  2. Middleware folder offering one middleware for each API where you add the Business Logic of each API
  3. Index file ready to run on top of the composer
  4. Ready to use model files based on the information you provided
  5. Ready to Run testing platform where you add your unit and integration tests.

Swagger Editor in SOAJS generate one middleware file for each API and supports multiple middleware for these APIs as well; split your business logic as you see fit.
Since the microservice is using the composer, the composer takes care of both business logic and model injection at run time. The composer even caters for handling database connectivity for both standalone and multitenant databases.


Development Boost:
Swagger Editor in SOAJS gives you a 70% Boost when it comes to building microservices. Simply provide your APIs' documentation, add couple of essential information, run the build command in your terminal and your microservice is generated. Then, fill in the business logic of your APIs and you are done ! 

Swagger in conjunction with the composer offers all the cool features listed above and enforce standardization.
This means your developers are now free of this pain and can concentrate more on the purpose of the microservice they want to build and how to build it and leave the rest to SOAJS to handle.


Build & Rebuild:

Generated microservice are also equipped with a Grunt Plugin from SOAJS that provides the ability to rebuild the REST Layer easily. 
This feature is very useful in later stages when you need to update the microservice, add/remove and change APIs. Again; change the documentation in the Yaml File, run the rebuild command in your terminal and you are done, the REST layer is now fully updated, configuration has been modified based on what you changed and the business logic of deprecated APIs still exists as orphan files for archiving purposes.