https://github.com/blvckbytes/springapidocgenerator

https://github.com/blvckbytes/springapidocgenerator

Last synced: 21 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/blvckbytes/springapidocgenerator
• Owner: BlvckBytes
• Created: 2023-11-25T22:51:38.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-02T17:40:07.000Z (about 1 year ago)
• Last Synced: 2023-12-03T00:28:28.429Z (about 1 year ago)
• Language: Kotlin
• Size: 107 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# SpringApiDocGenerator

This project represents my personal trial to come up with a way to automatically generate **proper** REST-API documentation.

What I mean by that is documentation that's fully aware of not only all input types (their origin, validation, name and schema) and all response types, but also all possible status-codes, including their meaning. The fact that all of this logic is encoded within the resulting fat jar of a Spring project, but I still have to go about hand-rolling my own documentation separately or be content with lacking, robot-looking and repetitive auto-generated YAMLs is totally unacceptable.

As this codebase currently reflects a playground for my ideas, it is of *horrible* design. You have been warned.