# 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::collection::LinkedList<std::shared_ptr<Endpoint>> 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::collection::LinkedList<std::shared_ptr<Endpoint>> Endpoints

# Generator::generateDocument

Generate Open Api Specification 3.0.0. from Generator::Endpoints.

oatpp::Object<oas3::Document> generateDocument(const std::shared_ptr<oatpp::swagger::DocumentInfo>& docInfo, const std::shared_ptr<Endpoints>& endpoints)