sptk::OpenApiGenerator Class Reference

#include <OpenApiGenerator.h>

Classes
struct	Options

Public Types
enum class	AuthMethod : uint8_t { NONE , BASIC , BEARER }

Public Member Functions
	OpenApiGenerator (const String &title, const String &description, const String &version, const Strings &servers, const Options &options)
void	generate (std::ostream &output, const WSOperationMap &operations, const WSComplexTypeMap &complexTypes, const std::map< String, String > &documentation) const

Static Public Member Functions
static AuthMethod	authMethod (const String &auth)
static String	authMethodName (AuthMethod auth)

Detailed Description

Generator of OpenAPI service description

Member Enumeration Documentation

AuthMethod

enum class sptk::OpenApiGenerator::AuthMethod : uint8_t

strong

Authentication method

Enumerator
NONE	No authentication.
BASIC	Authorization: Basic ZGVtbzpwQDU1dzByZA==.
BEARER	Authorization: Bearer <token>

Constructor & Destructor Documentation

OpenApiGenerator()

sptk::OpenApiGenerator::OpenApiGenerator	(	const String &	title,
		const String &	description,
		const String &	version,
		const Strings &	servers,
		const Options &	options
	)

Constructor

Parameters

title	Service title
description	Service description
version	Service version
servers	Servers that provide this service
options	Service options

Member Function Documentation

generate()

void sptk::OpenApiGenerator::generate	(	std::ostream &	output,
		const WSOperationMap &	operations,
		const WSComplexTypeMap &	complexTypes,
		const std::map< String, String > &	documentation
	)		const

Generate OpenAPI service description

Parameters

output	Output stream
operations	Service operations
complexTypes	Service types
documentation	Service documentation (by operation)

---

The documentation for this class was generated from the following file:

• OpenApiGenerator.h