Skip to content

A spring boot &swagger extension for creating REST services. Similar to Design first, works with Code First and Design First and yet a third approach. Aim: Reduce boiler plate controller code - handwritten or generated and rather rely on swagger specs only for same purpose. Also innovating some design best practices eg with parameters.

xdamah/swagger-xdamah

Repository files navigation

Maven Central

Hi there 👋

swagger-xdamah is a spring boot and swagger extension for creating REST services.
Its similar to Design first, works with Code First and Design First and yet a different third approach.
Its aim is to reduce boiler plate controller code whether handwritten or generated and rather rely on swagger specs only for same purpose. Also introducing some missing best practices when it comes to parameters.

It is hoped that the many new concepts here will eventually affect the existing traditional approaches.
If facing any difficulties or have feedback please inform using the issue tracker.

swagger-xdamah is demonstrated here https://github.com/xdamah/swagger-xdamah-examples .

Its always a challenge to describe something in the least words. The current features are listed here. Do please take take time to evaluate and consider. Feature list is expected to grow.:

  • 🔭 Minimalises generated code. Generates only the model code if so needed. Yes there are alternatives to model code generation. ... ...
  • 🤔 If Parameters are more than one in number wraps them into a java bean ...
  • 💬 Mixing code-first, design first and xdamah is possible ...
  • 📫 Reuse of parameter definitions. ...
  • 😄 For the same model its much easier to support requests in multiple media types - json, xml, form, multipart as swagger request ...
  • 👯 Demonstrated support for some other request types ...
  • ⚡ Demonstrates custom types and custom validation: ...
  • 🌱 Demonstrates FQN in code gen- (Added newly)

Many of these features are new concepts demonstrated here for the first time and nowhere else in the world.
Hopefully they will make an impact.

Read more here - https://github.com/xdamah/swagger-xdamah-examples: ...

In a nutshell: Its a new way to create springboot and swagger REST APIs with a unique approach and some extra features.

About

A spring boot &swagger extension for creating REST services. Similar to Design first, works with Code First and Design First and yet a third approach. Aim: Reduce boiler plate controller code - handwritten or generated and rather rely on swagger specs only for same purpose. Also innovating some design best practices eg with parameters.

Topics

Resources

Stars

Watchers

Forks

Languages