Diplomová práce

Generování SDK na základě OpenAPI specifikace

SDK Generation based on OpenAPI Specification (OAS)

Bc. Xuan Linh Phamová
Anotace

Cílem diplomové práce je implementace prototypu generátoru, který umí z poskytnutého OpenAPI dokumentu vygenerovat klientskou knihovnu. Výsledný kód má být určen pro práci s Kontentem od Kentica, konkrétně pro jeho integrační bod Delivery API. Účelem implementace prototypu je zjistit, zdali lze generovat kód se všemi potřebnými funkcemi pro práci s Delivery API, čímž by odpadla nutnost přímé údržby již existující klientské knihovny.

Abstract

The aim of the thesis is to implement a proof-of-concept generator which outputs a client library from a provided OpenAPI document. The generated code is intended to work with the integration point Delivery API of Kontent by Kentico. The purpose of implementing the prototype is to find out whether it is possible to generate code with all needed functions to work with Delivery API so that direct maintenance of existing client library is not needed.

Zadání práce
The aim of this thesis is to explore the OpenAPI specification (formerly Swagger) and assess its suitability for various scenarios in the context of Kentico. The theoretical part should cover scenarios such as automatic generation of SDKs and API documentation, and contract testing. In terms of SDK generation, the author should compare possible approaches (Swagger Codegen vs. OpenAPI Generator vs. custom tool vs. hybrid solution).

In the practical part, the author should implement a proof-of-concept version of a custom code generator for Kentico Kontent Delivery API. This should give the author a sense of OpenAPI capabilities and a great deal of experience in order to disclose any potential pitfalls and drawbacks of the specification.

Taking into consideration the current adoption rate of OpenAPI specification in Kentico, the author should make recommendations on how to move forward in terms of product development, automation, and processes.
Práce zkontrolována:
30. 5. 2022 23:19, doc. Ing. RNDr. Barbora Bühnová, Ph.D.
Jazyk práce
čeština čeština
Termín obhajoby
21. 6. 2022
Práce byla úspěšně obhájena

Vedoucí

doc. Ing. RNDr. Barbora Bühnová, Ph.D.
KPSK FI MU

Oponent

RNDr. Stanislav Chren, Ph.D., učo 255471
KPSK FI MU

Konzultant

Mgr. Ondřej Chrastina
Kentico Software

  • Přidání souboru

    Soubor nebo složku lze nahrát pomocí tlačítka Přidat.
  • Další operace se soubory

    Podrobnosti lze zjistit označením příslušného řádku.
  • Pohled pro experty

    Pro častou práci je možné zvolit režim Více možností.
  • Vyhledávání souborů

    Vyhledávaný výraz můžete zadat přímo do adresního řádku.
  • Rychlý přístup k souborům

    Pomocí funkce Nedávné je možné se rychle vrátit k právě prohlíženým souborům. Oblíbené soubory je také možné označit Hvězdičkou.