[MGNLREST-231] Decouple OpenAPI/Swagger support from RestDispatcherServlet Created: 03/Mar/20  Updated: 25/Mar/22

Status: Open
Project: Magnolia REST Framework
Component/s: tools
Affects Version/s: None
Fix Version/s: None

Type: Improvement Priority: Neutral
Reporter: Mikaël Geljić Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Relates
relates to MGNLREST-294 Rest Tools Loads Nothing Closed
causality
Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Date of First Response:

 Description   
  • Swagger support should *no longer* extend/replace RestDispatcherServlet
  • the "server part", i.e. the one producing the YAML spec should be extracted to its own servlet + dispatching filter
    • the server part should also be capable of generating specs (not from annotations), based on dynamically registered delivery endpoints => See MGNLREST-204
  • the "client part", i.e. the one rendering the docs/UI could be taken out of magnolia completely
  • Re: implementation, consider upgrade to swagger v2...

Generated at Mon Feb 12 06:57:55 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.