Configuring Swagger with Play/Java-framework-2.5

Question

I am trying to configure Swagger with my Play-2.5 project.

I followed this tutorial and it worked, but only for the older version of Play and not working with Play-2.5. As the project has migrated into Play-2.5, we had to remove the swagger configuration.

Firstly, the issue seemed to be with static controller vs non static controller in Play-2.5, but I ended up with proving myself wrong. I am facing this error

      type ApiHelpController is not a member of package controllers 
      GET         /api-docs                controllers.ApiHelpController.getResources

If any one knows any link for Swagger configuration with Play-2.5 for Java, please guide.

PS: there are tutorials available for Scala not for java.

Actually your question is about 'a way to integrate Swagger with Play-2.5'. Basically, it is not a problem whether you are doing a Java project or Scala project unless if there's a problem with annotator libraries . — Supun Wijerathne, May 19 '16 at 07:35

score 1 · Answer 1 · answered May 24 '16 at 16:10

1

Try this repo:

https://github.com/CreditCardsCom/swagger-play

I created this as a temporary workaround until we get support for Play 2.5 in the official swagger-play repo.

answered May 24 '16 at 16:10

kenske

2,235
2
20
27

this for scala not java, Do you have for java play.? – tree em Aug 22 '16 at 06:45
1

It _is_ for Java play. I'm currently using it with Java, not scala. – kenske Aug 23 '16 at 07:30
Could you guide how to integrate step by step , thanks – tree em Aug 24 '16 at 03:48

score 0 · Answer 2 · answered Apr 18 '16 at 19:28

0

I have only used the Play-Swagger project from Zalando. There is a lot of documentation and the repo is kept up-to-date.

If you want a quick start you can take a look at their Activator Template - just run it and you will get the Swagger generated documentation (Swagger UI is already included). From there you can start tweaking it (look for the conf/echo.yaml file).

answered Apr 18 '16 at 19:28

Anton Sarov

3,712
3
31
48

1

I have seen this before but again this all help out there for older versions and for Scala. I am looking for java with play 2.5. – M-sAnNan Apr 19 '16 at 06:57

Supun Wijerathne · Answer 3 · 2016-05-20T04:16:48.870

0

The problem is, the com.wordnik swagger-play2(What your tutorial is using as a library) breaks with Play 2.4 and up. You can try this which uses a different one (io.swagger). I have used this and it works well with 2.4. But it also breaks with 2.5.

edited May 20 '16 at 04:16

answered May 18 '16 at 09:58

Supun Wijerathne

11,964
10
61
87

Configuring Swagger with Play/Java-framework-2.5

3 Answers3