swagger-4-es provides a Swagger UI page for the key elasticsearch (and Opensearch) endpoints. It's aimed at being a training resource to engineers starting off with
elasticsearch. You may also consider customising the openapi specification (additional endpoints and notes) to become a training resource specific to your organisation.
See https://www.swarmee.net/swagger 4 es for further details.
FolloThe following steps run you through running
swagger-4-es swagger UI locally.
The following software and configuration is required on your computer to boot up the containers:
docker. See these docs for instructions.
docker-compose. See these docs for instructions.
- Increase the
mmapcount on linux systems. See these docs for instructions.
Then open https://localhost/index.html to see the Swagger UI page. The nginx container is setup to forward all to elasticsearch except for URLs ending in
- The Elasticsearch instance will take a little while to boot up - at least 15 seconds (you should see the messages scrolling through on your terminal as it starts up).
- The container starts a nginx reverse proxy to host the Swagger UI page, it generates a self signed certificate so you will need to accept the warning message in your browser. I.e. it is expected to see a
Warning: Potential Security Risk Aheadmessage when you open the Swagger UI link (Click Accept Risk and Proceed).
- No authentication is required for the local instance.
The local instance is also avaliable directly at http://localhost:9200