An application that collects and indexes swagger docs from your microservices architecture
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Swagger Search

Clojars Project

Swagger Search is an application that aggregates the Swagger/OpenAPI documentation of your microservice architecture in one place, where your can browse it or search endpoints based on their url, documentation, the parameters it accepts or their types.

Swagger Search also provides a Swagger UI for those microservices that haven't their own Swagger UI embedded.

Features

Service discovery

Integrated with Etcd and Consul for service discovery, or your can plug your own.

Search

The search is powered by Lucene, so you can use the Lucene's query syntax. An English analyzer is used.

The available fields are:

  1. service-name: the name specified on the info->title of the swagger doc or the basePath
  2. path: of the endpoint
  3. method: GET/POST/...
  4. summary-and-description
  5. parameters: name of the query/form/path/header parameter, or in the case of a body param, the name of any of the properties of the object or nested objects.
  6. responses: the name of any of the properties of the object or nested objects of any of the responses
  7. types: name of any $ref in parameters or responses

If no field is specified, all of them will be used.

Swagger UI and proxy

For each service, Swagger Search will try to find if that service comes with its own Swagger UI.

If it does, Swagger Search will use that UI when you click on a search result for that particular service.

If it does not, Swagger Search will use its own Swagger UI and a proxy to forward the requests.

Note that this proxy is very naive, so do not expose it outside your trusted network as it does not do any validations.

Run it

First you need to create a configuration file. Look at the example, which contains all the configuration options.

Docker

Copy or make the swagger.config.edn avaible in /config inside the container, something like:

docker run -p 7878:3000 -v `pwd`/examples:/config danlebrero/swagger-search

Open a browser at http://localhost:7878/

See DockerHub for the latest version.

Uberjar

Instead of Docker, you can just run the application manually as a JVM application:

  1. Install Java 8
  2. Download the latest release jar
  3. Specify the SWAGGER_HOME directory as a environment variable
  4. Place the configuration file in the SWAGGER_HOME directory. It must be called swagger.config.edn
  5. Run:
java -jar swaggersearch-vXXXX.jar

Open a browser at http://localhost:$whatever-port-you-specified-in-the-config-file/

Custom service discovery

Swagger Search needs to find out what services you are running. The built-in options are:

  1. Hardcoded list
  2. Read a local file
  3. Read a url
  4. Etcd
  5. Consul

The configuration example file has more details about each of them.

It is quite possible that none of these suits you, in which case next are the possible options to user your own service discovery

I dont know Clojure!

Your best option is to learn Clojure. It will do you a lot of good 😜.

Failing that, use the :uri-or-file provider and have a process that updates the file or write some HTTP server that is able to return the list of services.

Plugin a new provider

To create your own service discovery mechanism:

  1. Create a function like the Etcd one
  2. Package it
  3. Either add the package to the classpath or copy it to $SWAGGER_HOME/libs
  4. Add any additional jar dependencies to the classpath or to $SWAGGER_HOME/libs

Swagger Search as a library

If you don't want to run Docker or Uberjar, Swagger Search is also available as a library in Clojars.

See the uberjar code as guide about how you can use it as a library.

Known limitations

  1. No support for OpenAPI 3.0.
  2. Swagger 1.2 and below just indexes the url.
  3. Index is stored in memory.

Development

Go to examples/etcd and run:

docker-compose up

This should start a whole developer environment, including an application with a sample Swagger API.

Swagger Search will be available at http://localhost:8504/ and a Clojure REPL at localhost:8503

License

Copyright © 2017 IG Group

Distributed under Apache Licence 2.0.