Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/oatpp/oatpp-swagger
OpenApi 3.0.0 docs + Swagger UI for oatpp services
https://github.com/oatpp/oatpp-swagger
c-plus-plus cpp effortless oatpp openapi3 swagger swagger-ui
Last synced: 28 days ago
JSON representation
OpenApi 3.0.0 docs + Swagger UI for oatpp services
- Host: GitHub
- URL: https://github.com/oatpp/oatpp-swagger
- Owner: oatpp
- License: apache-2.0
- Created: 2018-07-27T20:59:35.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-06-04T23:13:34.000Z (8 months ago)
- Last Synced: 2024-10-29T23:47:25.348Z (3 months ago)
- Topics: c-plus-plus, cpp, effortless, oatpp, openapi3, swagger, swagger-ui
- Language: C++
- Homepage: https://oatpp.io/
- Size: 9.88 MB
- Stars: 94
- Watchers: 8
- Forks: 53
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# oatpp-swagger [](https://dev.azure.com/lganzzzo/lganzzzo/_build?definitionId=2)
Swagger UI for oatpp services
Read more:
- [About oatpp](https://oatpp.io/)
- [What is Swagger UI](https://swagger.io/tools/swagger-ui/)
- [Endpoint annotation and API documentation in oatpp](https://oatpp.io/docs/components/api-controller/#endpoint-annotation-and-api-documentation).
## Example
For full example project see: [Example CRUD-API project with Swagger UI](https://github.com/oatpp/example-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:/swagger/ui```
- OpenApi 3.0.0 specification location - ```http://localhost:/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("application/json");
info->addResponse(Status::CODE_200, "application/json");
info->addResponse(Status::CODE_500);
}
ENDPOINT("POST", "demo/api/users", createUser,
BODY_DTO(UserDto, 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, 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");
// When you are using the AUTHENTICATION() Endpoint-Macro you must add an SecurityScheme object (https://swagger.io/specification/#securitySchemeObject)
// For basic-authentication you can use the default Basic-Authorization-Security-Scheme like this
// For more complex authentication schemes you can use the oatpp::swagger::DocumentInfo::SecuritySchemeBuilder builder
// Don't forget to add info->addSecurityRequirement("basic_auth") to your ENDPOINT_INFO() Macro!
.addSecurityScheme("basic_auth", oatpp::swagger::DocumentInfo::SecuritySchemeBuilder::DefaultBasicAuthorizationSecurityScheme());
return builder.build();
}());
/**
* Swagger-Ui Resources (/lib/oatpp-swagger/res)
*/
OATPP_CREATE_COMPONENT(std::shared_ptr, swaggerResources)([] {
// Make sure to specify correct full path to oatpp-swagger/res folder !!!
return oatpp::swagger::Resources::loadResources("/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();
swaggerController->addEndpointsToRouter(router);
```
3) cmake :
Add the following lines to your CMakeLists.txt project file
```
find_package(oatpp 1.3.0 REQUIRED)
if(oatpp_FOUND)
message(STATUS "Found oatpp version: ${oatpp_VERSION_STRING}")
else()
message(FATAL_ERROR "Could not find oatpp")
endif()
find_package(oatpp-swagger 1.3.0 REQUIRED)
if(oatpp-swagger_FOUND)
message(STATUS "Found oatpp-swagger version: ${oatpp-swagger_VERSION_STRING}")
else()
message(FATAL_ERROR "Could not find oatpp-swagger")
endif()
include_directories(${oatpp_INCLUDE_DIRS})
include_directories(${oatpp-swagger_INCLUDE_DIRS})
add_definitions(
-DOATPP_SWAGGER_RES_PATH="${OATPP_BASE_DIR}/bin/oatpp-swagger/res"
)
target_link_libraries (project PUBLIC
// add_your libraries here
PUBLIC oatpp::oatpp
PUBLIC oatpp::oatpp-swagger
)
```
### Customise Swagger UI Paths
To customise swagger UI endpoints paths add the following component:
```c++
/**
* Swagger Controller Paths
*/
OATPP_CREATE_COMPONENT(std::shared_ptr, controllerPaths)([] {
auto paths = std::make_shared();
paths->apiJson = "custom/path/for/api.json"; // default is "api-docs/oas-3.0.0.json"
paths->ui = "my/custom/path/swagger-ui"; // default is "swagger/ui"
paths->uiResources = "my/custom/path/{filename}"; // default is "swagger/{filename}"
return paths;
}());
```
**NOTE:** `paths->ui` and `paths->uiResources` MUST have the same base path - as shown above.
**Done!**