Mapa de arquivos do repositório
Estrutura do projeto Doc Generate — metadados e OpenAPI (doc-generate):
| Arquivo | Metadados / função |
|---|---|
src/main.tlpp | U_sampleDOC(), sintaxe tlpp.doc.generate() |
src/components/sample_components.tlpp | DOC COMPONENT (antes TLPP COMPONENT) |
| 01_traditional_annotation/ | |
basic_description.tlpp | description texto |
extended_annotation.tlpp | title, params, responses |
| 02_dictionary_i18n/ | |
sample_basic_by_id.tlpp | description="<1>" |
sample_basic_by_id-i18n.tlpp | TRANSLATE + JSON DOC |
| 03_dedicated_function_doc/ | |
basic/json_object_return.tlpp | função DOC + JSON |
basic/multiline.tlpp | descriptionN |
basic/restdoc_object_return.tlpp | função DOC com objeto oDoc (recomendado) |
advanced/complete_api.tlpp | REST + Localize() |
advanced/complete_api_DOC.tlpp | JSON completo (JsonObject) |
advanced/complete_api*-i18n.tlpp | i18n REST e DOC |
advanced_with_object/complete_api_with_object.tlpp | REST + referência à função DOC com objeto |
advanced_with_object/complete_api_with_object_DOC.tlpp | DOC completo via oDoc (recomendado) |
advanced_with_object/complete_api_with_object_DOC-i18n.tlpp | i18n para DOC com objeto |
| 04_dynamic_mapping/ | |
dynamic_rest_start.tlpp | infra REST JSON |
dynamic_rest_services.tlpp | handlers |
dynamic_list_functions.tlpp | tlpp.doc.List() |
dynamic_rest_services_DOC.tlpp | DOC por endpoint |
| generator/ | |
openapi_generator.tlpp | GET /rest/sample/doc/generate + U_ListFilter |
output/api_doc_8080.yaml | Snapshot OpenAPI (também em Explorador) |
Próximo passo: Explorador OpenAPI — navegue o YAML no navegador. Trilha REST: Visão geral. Catálogo de fontes: Exemplos Doc Generate.