Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

REST API - ALPS UI (Swagger UI like) [closed]

I am evaluating Spring Data REST at the moment and I really like it.

What I am missing is a nicely presented, interactive documentation possibility similar to Swagger UI.

I know that Spring Data REST is not a static API and that there is HAL Browser, but unfortunately the HAL Browser does not show any documentational metadata about the corresponding url/GET/POST/etc.

Spring Data REST produces ALPS metadata (see here).


Why is this needed?
Well, it would be pretty useful for frontend developers and increase productivity from my point of view. Additionally every kind of auto-generated documentation saves a lot of time.


Long story short:
Is there something like "Swagger UI for ALPS/Hypermedia aware REST APIs"?


Additional information:
I already found a similar question that describes the problem, but I wasn't sure if its ok to reraise it, so I created this new one. Maybe in the meantime there are possible solutions.

like image 343
JDC Avatar asked Oct 18 '22 20:10

JDC


1 Answers

Put this in your dependencies and smoke it:

<dependencies>
    <dependency>
        <groupId>org.springframework.data</groupId>
        <artifactId>spring-data-rest-hal-browser</artifactId>
    </dependency>
</dependencies>

referenced at: /api/browser

I was just looking for the same thing today. ALPS is the metadata -- but SRD produces hal -- all you need is something to navigate HAL data and you're done.

like image 155
Christian Bongiorno Avatar answered Dec 25 '22 19:12

Christian Bongiorno