From b88a450ce8f256a0dce6c6b861257d94d2926dda Mon Sep 17 00:00:00 2001
From: Leonid Stryzhevskyi <lganzzzo@gmail.com>
Date: Thu, 2 Aug 2018 00:34:55 +0300
Subject: [PATCH] Update README.md

---
 README.md | 83 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 83 insertions(+)

diff --git a/README.md b/README.md
index 78e6961..993107e 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,85 @@
 # oatpp-swagger
 Swagger UI for oatpp services
+
+More about oatpp see [https://oatpp.io/](https://oatpp.io/)  
+More about Swagger UI see [https://swagger.io/tools/swagger-ui/](https://swagger.io/tools/swagger-ui/)
+
+## Example
+
+For full example project see: [Example CRUD-API project with Swagger UI](https://github.com/oatpp/oatpp-examples/tree/master/crud)
+
+## Brief
+
+- Use ```oatpp::swagger::Controller``` with ```oatpp::web::server::HttpConnectionHandler```
+- Use ```oatpp::swagger::AsyncController``` with ```oatpp::web::server::AsyncHttpConnectionHandler```
+
+- Swagger UI location - ```http://localhost:<PORT>/swagger/ui```
+- OpenApi 3.0.0 specification location - ```http://localhost:<PORT>/api-docs/oas-3.0.0.json```
+
+If you are using ```oatpp::web::server::api::ApiController``` most parts of your endpoints are documented automatically like:
+
+- Endpoint name
+- Parameters
+- Request Body
+
+You may add more information to your endpoint like follows:
+
+```c++
+ENDPOINT_INFO(createUser) {
+  info->summary = "Create new User";
+  info->addConsumes<UserDto::ObjectWrapper>("application/json");
+  info->addResponse<UserDto::ObjectWrapper>(Status::CODE_200, "application/json");
+}
+ENDPOINT("POST", "demo/api/users", createUser,
+         BODY_DTO(UserDto::ObjectWrapper, userDto)) {
+  return createDtoResponse(Status::CODE_200, m_database->createUser(userDto));
+}
+```
+
+### How to add Swagger UI to your project
+
+1) Add ```oatpp::swagger::DocumentInfo``` and ```oatpp::swagger::Resources``` components to your AppComponents:
+
+```c++
+/**
+ *  General API docs info
+ */
+OATPP_CREATE_COMPONENT(std::shared_ptr<oatpp::swagger::DocumentInfo>, swaggerDocumentInfo)([] {
+
+  oatpp::swagger::DocumentInfo::Builder builder;
+
+  builder
+  .setTitle("User entity service")
+  .setDescription("CRUD API Example project with swagger docs")
+  .setVersion("1.0")
+  .setContactName("Ivan Ovsyanochka")
+  .setContactUrl("https://oatpp.io/")
+
+  .setLicenseName("Apache License, Version 2.0")
+  .setLicenseUrl("http://www.apache.org/licenses/LICENSE-2.0")
+
+  .addServer("http://localhost:8000", "server on localhost");
+
+  return builder.build();
+
+}());
+
+
+/**
+ *  Swagger-Ui Resources (<oatpp-examples>/lib/oatpp-swagger/res)
+ */
+OATPP_CREATE_COMPONENT(std::shared_ptr<oatpp::swagger::Resources>, swaggerResources)([] {
+  // Make sure to specify correct full path to oatpp-swagger/res folder !!!
+  return oatpp::swagger::Resources::loadResources("<YOUR-PATH-TO-REPO>/lib/oatpp-swagger/res");
+}());
+
+```
+
+2) Create ```oatpp::swagger::Controller``` with list of endpoints you whant to document and add it to router:
+
+```c++
+auto swaggerController = oatpp::swagger::Controller::createShared(<list-of-endpoints-to-document>);
+swaggerController->addEndpointsToRouter(router);
+```
+
+**Done!**