/
1326: Add RAML & Swagger setup to the template service

1326: Add RAML & Swagger setup to the template service

Test Case #:1326

Test Case Name:Add RAML & Swagger setup to the template service

System: OpenLMIS

Subsystem: template-service

Test case designed by: Anna Czyrko

Design Date:22.11.2016

Short description

We want the RAML and Swagger setup we have in the example service (and all other services) also present in the template service, so that implementers get that out of the box when forking the template service.

*Acceptance criteria*

* RAML/Swagger is set up in the template service the same way it is in our other services.

* Swagger is used as a dependency, Swagger code does not live in our repository.

* The version endpoint is documented in the RAML.

                                                                                                                                                   

Pre – conditions:

                                                                                                                                                                                                                                                       

Step

Action

Expected system response

Comment

1

Start docker and run template -service:

sudo docker-compose run --service-ports template-service

                                                                                                                            

                                                 

2

In Terminal enter:

gradle clean

gradle build

gradle bootRun



3

In browser enter: http://localhost:8080/docs


4

Click default and GET



5Click Try it out

Should appear version in Response Body part.


Related content

846: Generate static (offline) documentation for services' APIs
846: Generate static (offline) documentation for services' APIs
More like this
853: Build information in every service/distribution
853: Build information in every service/distribution
More like this
876: Add Swagger for openlmis-auth
876: Add Swagger for openlmis-auth
More like this
591: RESTful web service testing setup
591: RESTful web service testing setup
More like this
1054: Print Proof of Delivery not working on openlmis-blue
1054: Print Proof of Delivery not working on openlmis-blue
More like this
Automate updating docker compose files
Automate updating docker compose files
More like this

OpenLMIS: the global initiative for powerful LMIS software