# Swagger-4-es (Swagger UI for Key Elasticsearch Endpoints)

**URL:** <https://discuss.elastic.co/t/swagger-4-es-swagger-ui-for-key-elasticsearch-endpoints/293012>\
**Category:** Elasticsearch\
**Tags:** docker\
**Created:** [December 28, 2021, 5:05am UTC](https://discuss.elastic.co/t/swagger-4-es-swagger-ui-for-key-elasticsearch-endpoints/293012 "2021-12-28T05:05:59Z")\
**Posts on this page:** 3\
**Page:** 1

<div class="post-metadata">

**Author:** ![Johnnycc1](https://sea2.discourse-cdn.com/elastic/user_avatar/discuss.elastic.co/johnnycc1/32/26069_2.png) [@Johnnycc1](https://discuss.elastic.co/u/Johnnycc1)\
**Post date:** [December 28, 2021, 5:05am UTC](https://discuss.elastic.co/t/swagger-4-es-swagger-ui-for-key-elasticsearch-endpoints/293012/1 "2021-12-28T05:05:59Z")

</div>

Hey Elasticsearch community,

I have created an openapi schema for the key Elasticsearch endpoints (or at least the ones I think are key). If you don't know what that is, basically when paired with the swagger-ui library it provides interactive documentation that allows you to submit requests and receive responses in a simple web page.

Its not intended to be complete/exhaustive, however I think its a really good start for somebody starting off with Elasticsearch - just to get across the basics.

The link to the web page where I describe what I have done is [here](https://www.swarmee.net/swagger%204%20es/)

The openapi.json file can be found [here](https://swagger-4-es.swarmee.net/swagger-4-es-openapi.json)

I have also uploaded a series of videos that runs through how to use the swagger UI page [here](https://www.swarmee.net/swagger%204%20es/training-videos/). I think these provide a solid foundation on how to use Elasticsearch.

The container setup to run the swagger UI page locally and the fastapi application I used to generate the schema can be found on [github](https://github.com/swarmee/swagger-4-es).

You can give me a github star if you think its useful.

---

<div class="post-metadata">

**Author:** ![warkolm](https://sea2.discourse-cdn.com/elastic/user_avatar/discuss.elastic.co/warkolm/32/39224_2.png) [@warkolm](https://discuss.elastic.co/u/warkolm)\
**Post date:** [January 4, 2022, 7:42am UTC](https://discuss.elastic.co/t/swagger-4-es-swagger-ui-for-key-elasticsearch-endpoints/293012/2 "2022-01-04T07:42:45Z")

</div>

Thanks for sharing this!

---

<div class="post-metadata">

**Author:** ![system](https://us1.discourse-cdn.com/elastic/original/3X/1/a/1ac57faf039f6b580b3f104ef42a2a89e41014de.png) [@system](https://discuss.elastic.co/u/system)\
**Post date:** [February 1, 2022, 7:43am UTC](https://discuss.elastic.co/t/swagger-4-es-swagger-ui-for-key-elasticsearch-endpoints/293012/3 "2022-02-01T07:43:05Z")

</div>

This topic was automatically closed 28 days after the last reply. New replies are no longer allowed.