kidwellj/findcommonground.uk
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Update 2016-04-05-generate-swagger.md

Browse source
This commit is contained in:
Teodora Onaca 2016-04-05 12:05:26 +02:00
parent 3b15de3d3c
commit d47c6b9708
1 changed files with 3 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
_posts/2016-04-05-generate-swagger.md
View file

@ -1,5 +1,4 @@
---
---
layout: post layout: post
title: Generating Swagger from your API title: Generating Swagger from your API
subtitle: How to quickly generate the swagger documentation from your existing API. subtitle: How to quickly generate the swagger documentation from your existing API.
@ -8,7 +7,7 @@ tags: [devops]
author: teodora_onaca author: teodora_onaca
author_email: teodora.onaca@haufe-lexware.com author_email: teodora.onaca@haufe-lexware.com
header-img: "images/bg-post.old.jpg" header-img: "images/bg-post.old.jpg"
--- ---
If you already have an existing API and you just want to generate the swagger documentation from it, there are a couple easy steps to make it work. First off, you should be familiar with Swagger and, in particular, with [swagger-core](https://github.com/swagger-api/swagger-core). Assuming that you coded your REST API using JAX-RS, based on which was your library of choice (Jersey or RESTEasy), there are several [guides](https://github.com/swagger-api/swagger-core/wiki/Swagger-Core-JAX-RS-Project-Setup-1.5.X) available to get you set up very fast. If you already have an existing API and you just want to generate the swagger documentation from it, there are a couple easy steps to make it work. First off, you should be familiar with Swagger and, in particular, with [swagger-core](https://github.com/swagger-api/swagger-core). Assuming that you coded your REST API using JAX-RS, based on which was your library of choice (Jersey or RESTEasy), there are several [guides](https://github.com/swagger-api/swagger-core/wiki/Swagger-Core-JAX-RS-Project-Setup-1.5.X) available to get you set up very fast.
@ -174,4 +173,4 @@ In order to fix this, use `@ApiParam(hidden=true)` for the subresource `@PathPar
} }
There might be more tips and tricks that you will discover once you start using the annotations for your API, but it will not be a slow learning curve and once you are familiar with swagger (both spec and core) you will be able to document your API really fast. There might be more tips and tricks that you will discover once you start using the annotations for your API, but it will not be a slow learning curve and once you are familiar with swagger (both spec and core) you will be able to document your API really fast.