# Generator.hpp
This File On Github
Ask A Question
API: latest
module: oatpp-swagger
#include "oatpp-swagger/Generator.hpp"
# Generator
Generator of Open Api Specification 3.0.0.
namespace oatpp { namespace swagger {
class Generator {}
}}
# Typedefs
Type | Name | Summary |
---|---|---|
oatpp::web::server::api::Endpoint | Endpoint | Convenience typedef for oatpp::web::server::api::Endpoint. |
oatpp::web::server::api::Endpoints | Endpoints | Convenience typedef for list of Generator::Endpoint. |
# Methods
Return Type | Name | Summary |
---|---|---|
oatpp::Object<oas3::Document> | generateDocument | Generate Open Api Specification 3.0.0. from Generator::Endpoints. |
# Generator::Endpoint
Convenience typedef for oatpp::web::server::api::Endpoint.
typedef oatpp::web::server::api::Endpoint Endpoint
# Generator::Endpoints
Convenience typedef for list of Generator::Endpoint.
typedef oatpp::web::server::api::Endpoints Endpoints
# Generator::generateDocument
Generate Open Api Specification 3.0.0. from Generator::Endpoints.
- @param docInfo - oatpp::swagger::DocumentInfo.
- @param endpoints Generator::Endpoints.
- @return - oatpp::swagger::oas3::Document.
oatpp::Object<oas3::Document> generateDocument(const std::shared_ptr<oatpp::swagger::DocumentInfo>& docInfo, const Endpoints& endpoints)