[MGNLREST-1] As a developer I can browse and test the API of the provided webservices Created: 06/May/13  Updated: 22/Nov/13  Resolved: 29/Oct/13

Status: Closed
Project: Magnolia REST Framework
Component/s: None
Affects Version/s: None
Fix Version/s: 1.0

Type: Story Priority: Neutral
Reporter: Magnolia International Assignee: Philip Mundt
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Relates
relates to MGNLREST-23 Make additional provider (for RestDis... Closed
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)
Release notes required:
Yes
Date of First Response:
Epic Link: REST support
Sprint: 5.2-rc1

 Description   

Investigate if it'd be possible to generating API documentation and clients - e.g. using Swagger:

OR - see what Atlassian does: WADL with Maven plugin - https://developer.atlassian.com/display/DOCS/Documenting+your+APIs+with+the+Atlassian+REST+API+Browser

If not, as a minimal starting point, the module has a /mgnl-resources/json-debug.html - could we build a small app around that ?



 Comments   
Comment by Tobias Mattsson [ 24/Oct/13 ]

I'd prefer this to be a separate module, mostly based on the dependencies it adds, such as scala libraries.

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