{"id":29177722,"url":"https://github.com/totvs/tlpp-sample-rest-documentation","last_synced_at":"2026-02-04T17:32:35.146Z","repository":{"id":142750854,"uuid":"613900667","full_name":"totvs/tlpp-sample-rest-documentation","owner":"totvs","description":"Exemplos de uso do motor de documentação REST do tlppCore","archived":false,"fork":false,"pushed_at":"2025-02-19T13:21:56.000Z","size":129,"stargazers_count":23,"open_issues_count":2,"forks_count":6,"subscribers_count":14,"default_branch":"main","last_synced_at":"2025-07-01T18:10:40.153Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://tdn.totvs.com/pages/viewpage.action?pageId=745121740","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/totvs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-03-14T13:51:41.000Z","updated_at":"2025-06-20T14:08:13.000Z","dependencies_parsed_at":null,"dependency_job_id":"86c4e61d-cd7c-4248-8d65-2d24c5d9f657","html_url":"https://github.com/totvs/tlpp-sample-rest-documentation","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/totvs/tlpp-sample-rest-documentation","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/totvs%2Ftlpp-sample-rest-documentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/totvs%2Ftlpp-sample-rest-documentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/totvs%2Ftlpp-sample-rest-documentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/totvs%2Ftlpp-sample-rest-documentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/totvs","download_url":"https://codeload.github.com/totvs/tlpp-sample-rest-documentation/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/totvs%2Ftlpp-sample-rest-documentation/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29091853,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-04T03:31:03.593Z","status":"ssl_error","status_checked_at":"2026-02-04T03:29:50.742Z","response_time":62,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-07-01T18:07:50.637Z","updated_at":"2026-02-04T17:32:35.128Z","avatar_url":"https://github.com/totvs.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"tlpp logo\" src=\"images/tlpp_logo.jpg\" width=\"250px\" /\u003e\n  \u003ch1 align=\"center\"\u003eEXEMPLOS: Documentação de APIs REST em TLPP\u003c/h1\u003e\n\u003c/p\u003e\n\n\u003e [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\u003cbr\u003eEsta é uma iniciativa open source, sob **Licença MIT**, e como tal, é disponibilizada **sem qualquer garantia, expressa ou implícita**, não havendo restrições sobre usar, copiar, modificar, fundir, publicar, distribuir, sublicenciar e/ou vender cópias de seu conteúdo.\n\n## Informações importantes\n\nO **tlppCore** contém uma ferramenta nativa para a geração de documentação das APIs presentes no ambiente. Esse motor será distribuído através do tlpp.rpo juntamente com o appserver e esta ferramenta não estará sob a licença MIT. O motor é de *propriedade* da **TOTVS S/A**.\n\n**Versão disponível:** O motor estará disponível a partir do tlppCore 01.04.02 + AppServer 20.3.1.10.\n\nO projeto contindo nesse repositório não é a implementação do motor de geração da documentação do tlppCore mencionada acima, portanto os fontes aqui presentes são apenas exemplos de como utilizar os recursos disponíveis para a geração dos documentos.\n\n\u003e \u003chr\u003e\n\u003e \u003cdiv style=\"align-items: center; display: flex;\"\u003e\u0026nbsp;\u0026nbsp;\u003cimg alt=\"tlpp logo\" src=\"images/icons/disclaimer.png\" width=\"32px\" /\u003e\u0026nbsp;\u0026nbsp;\u003cb\u003eDISCLAIMER\u003c/b\u003e\u003c/div\u003e\n\u003e \u003cbr\u003e\n\u003e O módulo REST-DOC é um recurso extremamente novo no tlppCore e ainda está em fase de implementação. O produto está recebendo contantes ajustes, melhorias e, portanto, sua documentação ainda está em fase de construção.\n\u003e \u003cbr\u003e\u003cbr\u003e\n\u003e Agradecemos o interesse em avaliar o produto, e nos colocamos à inteira disposição para eventuais dúvidas.\u003cbr\u003ePor favor, usufruam do recurso de abertura de Issues para esse projeto!\n\u003e \u003chr\u003e\n\n## Exemplos\n\nOs exemplos implementados nesse projeto traz luz ao aprendizado sobre a ferramenta, porém é imprescendível que a documentação oficial do motor seja lida através da [Wiki](https://github.com/totvs/tlpp-sample-rest-documentation/wiki) para obter detalhes de uso dos recursos disponibilizados.\n\n### Exemplos Básicos\n\n- ***Somente descrição:*** \\src\\rest\\basic\\sample_01_basic.tlpp\n- ***Documentando utilizando annotation:*** \\src\\rest\\basic\\sample_02_basic.tlpp\n- ***Documentando diretamente no i18n:*** \\src\\rest\\basic\\sample_03_basic_by_id.tlpp\n- ***Documentando através de função:*** \\src\\rest\\basic\\sample_04_basic_by_function.tlpp\n- ***Descrição multi-linha:*** \\src\\rest\\basic\\sample_05_basic_multiline.tlpp\n\n### Exemplo Completo (Documentação + Componente + i18n)\n\nResumo do exemplo completo -\u003e [complete.md](https://github.com/totvs/tlpp-sample-rest-documentation/blob/main/src/rest/complete/complete.md)\n\n- ***REST:*** \\src\\rest\\complete\\sample_complete.tlpp\n- ***REST (localização):*** \\src\\rest\\complete\\sample_complete-i18n.tlpp\n- ***DOC:*** \\src\\rest\\complete\\sample_complete_DOC.tlpp\n- ***DOC (localização):*** \\src\\rest\\complete\\sample_complete_DOC-i18n.tlpp\n- ***Componente:*** \\src\\components\\sample_components.tlpp\n\n### Endpoints dinâmicos criados por JSON\n\nO REST tlppCore possibilita a subida e criação de serviços REST através de JSON de forma dinâmica, e portanto esses serviços não utilizam Annotation.\n\nOs exemplos abaixo criam DOC para esses casos.\n\n- ***Infraestrutura + EndPoints:*** src\\rest\\dynamic endpoints\\dynamic_rest_start.tlpp\n- ***REST:*** src\\rest\\dynamic endpoints\\dynamic_rest_services.tlpp\n- ***DOC List:*** src\\rest\\dynamic endpoints\\dynamic_list_functions.tlpp\n- ***DOC REST:*** src\\rest\\dynamic endpoints\\dynamic_rest_services_DOC.tlpp\n\n## Gerando a documentação\n\nPara gerar a documentação dos exemplos desse projeto, como também dos documentos criados por você, será necessário executar a função do tlppCore capaz de gerar o documento final.\n\n\u003e **Atenção:** Antes de executar a função, é imprescendível que o serviço REST esteja funcionando e acessível.\n\nApós o ambiente estiver disponível, a execução será através da seguinte função:\n```\ntlpp.doc.generate( 'swagger', 'api_doc', {8080} )\n```\nPara mais detalhes sobre a sintaxe, veja em: *\\src\\main.tlpp*\n\nNesse projeto, há uma cópia do arquivo gerado com o resultado desses exemplos.\nEsse arquivo você pode acessar em: *\\output\\api_doc_8080.yaml*\n\n\u003e Pode-se validar o arquivo gerado através de uma ferramenta disponibilizada pela SmartBear Software, basta acessar a seguinte URL: [editor.swagger.io](https://editor.swagger.io/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftotvs%2Ftlpp-sample-rest-documentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftotvs%2Ftlpp-sample-rest-documentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftotvs%2Ftlpp-sample-rest-documentation/lists"}