giant-otter

This API application collects and shows several swagger apis.

New Features!

v1.0.1

• Fixed the 'org.springframework.hateoas.mediatype.PropertyUtils' cannot find read-write method error

v1.0.0

• You can view API documentation from multiple API servers in one place using the OpenAPI Spec.
• Automatically convert API server documentation with 2.x Spec to 3.x Spec.
• Update the API Spec every 5 minutes by crawling for changes.
• APIs can be queried by group.

Installation

Quick start

Java, Docker must be installed before starting. Standalone system using embedded mongo database.

git clone https://github.com/stray-cat-developers/giant-otter.git
./quick-start.sh

Swagger api page is http://localhost:6200/swagger-ui.html

How to use

• run ./quick-start.sh

• http://localhost:6200/swagger-ui.html

• add another swagger spec

  • use api

    curl -X POST "http://localhost:6200/swagger/specifications?category=PET&description=pet%20store%20sample&name=Pet%20Store&type=JSON&url=https%3A%2F%2Fpetstore.swagger.io%2Fv2%2Fswagger.json&version=2.0" -H "accept: */*"

  or

  • use swagger doc
    open http://localhost:6200/swagger-ui.html#/Management/addUsingPOST

    input form

    • category: Group name to classify
    • description: description
    • name: api system name
    • type: api system swagger type (Json or yaml)
    • headers: headers required when calling api ex) authentication, sample user id, etc...
    • version: api system swagger document spec version

• crawling page

    curl -X PUT "http://localhost:6200/crawling/manual" -H "accept: */*"

• refresh http://localhost:6200/swagger-ui.html

Note

To do the api test in giant-otter, you need to do the following:

1. Registering the api system should solve the cors problem.
2. The api spec is automatically crawled every 5 minutes.