This project is targeting people who want to implement Rest APIs server and client code just designing a Swagger specification. You will not need to understand every framework specification (flavours) like Spring, JAX-RS, JQuery, etc., we will do for you, you will only implement your business code!
Time. Nowadays, developers spend so much time understanding new frameworks when their milestones are usually getting shorter, being quite hard to look into third party libraries.
Variety. There are several ways to define a Rest communication between client and server and not all the architectures support specific frameworks.
Team coordination. When different teams (e.g. one as front-end and another as back-end) have to work together in a project, some misunderstanding problems could appear. To avoid those problems, it could be necessary "mocks" to work independently or any common specification to define the Rest endpoints.
API Rest Generator is the solution for the previous problems:
- Imagine a Website where you import your API specification, choose a flavour and the outcome is a complete implementation for your endpoints.
- Imagine that the outcome also contains an example project with all your endpoints, to be useful not only for validating your code generation but also as "mocks" for other teams.
- Finally, imagine that the only thing to implement is your business code, i.e. no annotations, no remote calls, etc., just implement the listeners!
This is API Rest Generator: simple and flexible!
- You only need to import your API specification, use one of the examples or code a new one in the text area.
- Choose one of the current available frameworks and click on it.
- It will generate different artifacts and an example project based on the input specification.
- Use the example project to start your work or share with other teams!
- The project is divided in different modules to implement new flavours easily and avoid the coupling.
- You can also implement new parsers
- Feel free to implement a new ones!
Nowadays, we have implemented a parser for Swagger SPEC but we would like to add a RAML parser in the near future ;)
For server:
- Spring MVC
- JAX-RS (CXF) - The generation is compatible with OSGi
For client:
- Javascript (JQuery) - Implemented and compiled by Typescript previously
- Angular2
- JAX-RS (CXF) - The generation is compatible with OSGi
- Feign
- Java 1.7_80+
- Typescript in your classpath
- Maven in your classpath and connection to Maven Repository.
After downloading the project, you have to compile the modules with Maven. In the parent project execute:
mvn clean install
Unix Go to JavaProject path and execute "serverLauncher.sh" and then "clientLauncher.sh".
Windows Go to JavaProject path and execute "serverLauncher.cmd" and then "clientLauncher.cmd".
Finally, open your browser and go to http://localhost:36200 (or the address you have chosen in the properties file “application.yml” - Project: web.client).