<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
    <channel>
        <title>API on Dev TLDRLSS</title>
        <link>https://dev.tldrlss.com/pt/tags/api/</link>
        <description>Recent content in API on Dev TLDRLSS</description>
        <generator>Hugo -- gohugo.io</generator>
        <language>pt</language>
        <lastBuildDate>Sun, 02 Aug 2026 15:08:41 +0800</lastBuildDate><atom:link href="https://dev.tldrlss.com/pt/tags/api/index.xml" rel="self" type="application/rss+xml" /><item>
        <title>Qual a Diferença Entre Manifest, Report e Finding? O Que Significam os Termos de Hierarquia de Dados na Arquitetura de Software? Por Que Projetar uma API em Camadas? Como Metadata, Artifact e Payload Se Diferenciam!</title>
        <link>https://dev.tldrlss.com/pt/article/2026/08/whats-manifest-report-finding-evidence-metadata-artifact-payload-data-model-hierarchy/</link>
        <pubDate>Sun, 02 Aug 2026 15:08:41 +0800</pubDate>
        
        <guid>https://dev.tldrlss.com/pt/article/2026/08/whats-manifest-report-finding-evidence-metadata-artifact-payload-data-model-hierarchy/</guid>
        <description>&lt;img src="https://dev.tldrlss.com/global-assets/article/2026/08/whats-manifest-report-finding-evidence-metadata-artifact-payload-cover.jpg" alt="Featured image of post Qual a Diferença Entre Manifest, Report e Finding? O Que Significam os Termos de Hierarquia de Dados na Arquitetura de Software? Por Que Projetar uma API em Camadas? Como Metadata, Artifact e Payload Se Diferenciam!" /&gt;&lt;p&gt;Você costuma encontrar termos como &lt;code&gt;Manifest&lt;/code&gt;, &lt;code&gt;Report&lt;/code&gt;, &lt;code&gt;Finding&lt;/code&gt; e &lt;code&gt;Evidence&lt;/code&gt; ao ler documentações de &lt;code&gt;API&lt;/code&gt;, relatórios de ferramentas de segurança ou logs de &lt;code&gt;CI/CD&lt;/code&gt;? Eles não são sintaxes de uma linguagem de programação específica, mas sim &lt;strong&gt;termos de hierarquia de dados&lt;/strong&gt; padronizados na indústria. O que esses termos realmente significam?&lt;/p&gt;
&lt;h2 id=&#34;conceito-chave-entendendo-a-hierarquia-de-dados-através-de-um-exame-médico&#34;&gt;Conceito Chave: Entendendo a Hierarquia de Dados Através de um &amp;ldquo;Exame Médico&amp;rdquo;
&lt;/h2&gt;&lt;p&gt;Podemos imaginá-los como o processo de fazer um &lt;strong&gt;exame médico&lt;/strong&gt; em um hospital. Esses quatro termos correspondem exatamente aos níveis de dados, desde resumos de alto nível até dados brutos na camada mais baixa.&lt;/p&gt;
&lt;table&gt;
  &lt;thead&gt;
      &lt;tr&gt;
          &lt;th&gt;Termo&lt;/th&gt;
          &lt;th&gt;Analogia com Exame Médico&lt;/th&gt;
          &lt;th&gt;Explicação na Arquitetura de Software&lt;/th&gt;
      &lt;/tr&gt;
  &lt;/thead&gt;
  &lt;tbody&gt;
      &lt;tr&gt;
          &lt;td&gt;&lt;code&gt;Manifest&lt;/code&gt;&lt;/td&gt;
          &lt;td&gt;Ficha de Inscrição do Exame&lt;/td&gt;
          &lt;td&gt;Declara quais itens serão executados, versões e configurações de ambiente; são dados descritivos.&lt;/td&gt;
      &lt;/tr&gt;
      &lt;tr&gt;
          &lt;td&gt;&lt;code&gt;Report&lt;/code&gt;&lt;/td&gt;
          &lt;td&gt;Relatório Médico Completo&lt;/td&gt;
          &lt;td&gt;Resumo completo após a execução, incluindo status geral e resultados de auditoria.&lt;/td&gt;
      &lt;/tr&gt;
      &lt;tr&gt;
          &lt;td&gt;&lt;code&gt;Finding&lt;/code&gt;&lt;/td&gt;
          &lt;td&gt;Anotação em Vermelho no Relatório&lt;/td&gt;
          &lt;td&gt;Descoberta específica destacada no relatório, como &amp;ldquo;Hipertensão Detectada&amp;rdquo; ou vulnerabilidade de segurança.&lt;/td&gt;
      &lt;/tr&gt;
      &lt;tr&gt;
          &lt;td&gt;&lt;code&gt;Evidence&lt;/code&gt;&lt;/td&gt;
          &lt;td&gt;Tira de Dados do Esfigmomanômetro&lt;/td&gt;
          &lt;td&gt;Evidência bruta e objetiva que fundamenta a descoberta, como registros de log ou medições.&lt;/td&gt;
      &lt;/tr&gt;
  &lt;/tbody&gt;
&lt;/table&gt;
&lt;blockquote&gt;
&lt;p&gt;&lt;strong&gt;Estes termos não são palavras reservadas de linguagens de programação, mas modelos de dados compartilhados da indústria.&lt;/strong&gt;&lt;/p&gt;
&lt;/blockquote&gt;
&lt;p&gt;Podemos usar um diagrama &lt;code&gt;Mermaid&lt;/code&gt; para ilustrar as relações de inclusão e fluxo de dados entre estes quatro conceitos:&lt;/p&gt;
&lt;pre class=&#34;mermaid&#34;&gt;
  graph TD
    A[&amp;#34;Manifest (Espec. de Execução/Metadatos)&amp;#34;] --&amp;gt;|Define Escopo e Execução| B[&amp;#34;Report (Relatório de Resumo Completo)&amp;#34;]
    B --&amp;gt;|Contém Múltiplos| C[&amp;#34;Finding (Descoberta Específica/Observação)&amp;#34;]
    C --&amp;gt;|Associa Múltiplos| D[&amp;#34;Evidence (Evidência Bruta Objetiva)&amp;#34;]
&lt;/pre&gt;

&lt;!--adsense--&gt;
&lt;h2 id=&#34;por-que-projetar-em-camadas-as-3-grandes-vantagens-da-hierarquia-de-dados&#34;&gt;Por Que Projetar em Camadas? As 3 Grandes Vantagens da Hierarquia de Dados
&lt;/h2&gt;&lt;p&gt;Por que dividir os dados com tanto detalhe em vez de colocar tudo em um único objeto &lt;code&gt;JSON&lt;/code&gt; gigante? Esse design oferece várias vantagens importantes:&lt;/p&gt;
&lt;blockquote&gt;
&lt;p&gt;&lt;strong&gt;Um excelente design de arquitetura de API torna o carregamento no frontend mais fluido e aumenta a confiabilidade e extensibilidade dos dados.&lt;/strong&gt;&lt;/p&gt;
&lt;/blockquote&gt;
&lt;table&gt;
  &lt;thead&gt;
      &lt;tr&gt;
          &lt;th&gt;Vantagem&lt;/th&gt;
          &lt;th&gt;Explicação&lt;/th&gt;
      &lt;/tr&gt;
  &lt;/thead&gt;
  &lt;tbody&gt;
      &lt;tr&gt;
          &lt;td&gt;&lt;strong&gt;Separação de Responsabilidades&lt;/strong&gt;&lt;/td&gt;
          &lt;td&gt;O frontend pode carregar primeiro o resumo de &lt;code&gt;Finding&lt;/code&gt; para visualização rápida, buscando o pesado &lt;code&gt;Evidence&lt;/code&gt; apenas quando necessário aprofundar.&lt;/td&gt;
      &lt;/tr&gt;
      &lt;tr&gt;
          &lt;td&gt;&lt;strong&gt;Alta Confiabilidade&lt;/strong&gt;&lt;/td&gt;
          &lt;td&gt;Fornecer &lt;code&gt;Evidence&lt;/code&gt; prova que um &lt;code&gt;Finding&lt;/code&gt; não é um falso positivo, aumentando significativamente a auditabilidade do sistema.&lt;/td&gt;
      &lt;/tr&gt;
      &lt;tr&gt;
          &lt;td&gt;&lt;strong&gt;Extensibilidade Flexível&lt;/strong&gt;&lt;/td&gt;
          &lt;td&gt;Um único &lt;code&gt;Finding&lt;/code&gt; pode ser associado flexivelmente a múltiplos &lt;code&gt;Evidence&lt;/code&gt; sem quebrar a estrutura de dados original.&lt;/td&gt;
      &lt;/tr&gt;
  &lt;/tbody&gt;
&lt;/table&gt;
&lt;h2 id=&#34;outros-termos-comuns-complementarios-metadata-artifact-e-payload&#34;&gt;Outros Termos Comuns Complementarios: Metadata, Artifact e Payload
&lt;/h2&gt;&lt;p&gt;Além das quatro camadas principais, ao projetar &lt;code&gt;API&lt;/code&gt;, construir pipelines ou definir formatos de transmissão, você verá com frequência estes três termos: &lt;code&gt;Metadata&lt;/code&gt;, &lt;code&gt;Artifact&lt;/code&gt; e &lt;code&gt;Payload&lt;/code&gt;:&lt;/p&gt;
&lt;table&gt;
  &lt;thead&gt;
      &lt;tr&gt;
          &lt;th&gt;Termo&lt;/th&gt;
          &lt;th&gt;Definição Principal&lt;/th&gt;
          &lt;th&gt;Analogia da Vida Real&lt;/th&gt;
          &lt;th&gt;Exemplo de Aplicação Prática na Arquitetura de Software&lt;/th&gt;
      &lt;/tr&gt;
  &lt;/thead&gt;
  &lt;tbody&gt;
      &lt;tr&gt;
          &lt;td&gt;&lt;code&gt;Metadata&lt;/code&gt;&lt;/td&gt;
          &lt;td&gt;Dados que descrevem os próprios dados&lt;/td&gt;
          &lt;td&gt;Etiqueta de envio em uma encomenda, dados EXIF de foto&lt;/td&gt;
          &lt;td&gt;&lt;code&gt;HTTP Header&lt;/code&gt;, carimbo de data/hora &lt;code&gt;timestamp&lt;/code&gt;, informação de paginação &lt;code&gt;page&lt;/code&gt;.&lt;/td&gt;
      &lt;/tr&gt;
      &lt;tr&gt;
          &lt;td&gt;&lt;code&gt;Artifact&lt;/code&gt;&lt;/td&gt;
          &lt;td&gt;Entidade física gerada após o processo&lt;/td&gt;
          &lt;td&gt;Carro produzido em fábrica, CD de exame médico&lt;/td&gt;
          &lt;td&gt;Arquivo &lt;code&gt;.apk&lt;/code&gt; compilado, &lt;code&gt;Docker Image&lt;/code&gt;, relatório &lt;code&gt;PDF&lt;/code&gt; de auditoria.&lt;/td&gt;
      &lt;/tr&gt;
      &lt;tr&gt;
          &lt;td&gt;&lt;code&gt;Payload&lt;/code&gt;&lt;/td&gt;
          &lt;td&gt;Dados de negócio principais a serem transmitidos&lt;/td&gt;
          &lt;td&gt;O smartphone real dentro da caixa da encomenda&lt;/td&gt;
          &lt;td&gt;Conteúdo principal de negócio &lt;code&gt;JSON&lt;/code&gt; dentro do &lt;code&gt;HTTP POST Body&lt;/code&gt;.&lt;/td&gt;
      &lt;/tr&gt;
  &lt;/tbody&gt;
&lt;/table&gt;
&lt;blockquote&gt;
&lt;p&gt;&lt;code&gt;Payload&lt;/code&gt; &lt;strong&gt;é como o item dentro da encomenda&lt;/strong&gt;, enquanto &lt;code&gt;Metadata&lt;/code&gt; &lt;strong&gt;é a etiqueta de envio colada do lado de fora&lt;/strong&gt;.&lt;/p&gt;
&lt;/blockquote&gt;
&lt;p&gt;Para entender melhor como esses três atuam em conjunto, observe uma estrutura de dados típica de &lt;code&gt;API Request&lt;/code&gt;:&lt;/p&gt;
&lt;div class=&#34;highlight&#34;&gt;&lt;pre tabindex=&#34;0&#34; class=&#34;chroma&#34;&gt;&lt;code class=&#34;language-json&#34; data-lang=&#34;json&#34;&gt;&lt;span class=&#34;line&#34;&gt;&lt;span class=&#34;cl&#34;&gt;&lt;span class=&#34;p&#34;&gt;{&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span class=&#34;line&#34;&gt;&lt;span class=&#34;cl&#34;&gt;  &lt;span class=&#34;nt&#34;&gt;&amp;#34;metadata&amp;#34;&lt;/span&gt;&lt;span class=&#34;p&#34;&gt;:&lt;/span&gt; &lt;span class=&#34;p&#34;&gt;{&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span class=&#34;line&#34;&gt;&lt;span class=&#34;cl&#34;&gt;    &lt;span class=&#34;nt&#34;&gt;&amp;#34;version&amp;#34;&lt;/span&gt;&lt;span class=&#34;p&#34;&gt;:&lt;/span&gt; &lt;span class=&#34;s2&#34;&gt;&amp;#34;v1.2.0&amp;#34;&lt;/span&gt;&lt;span class=&#34;p&#34;&gt;,&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span class=&#34;line&#34;&gt;&lt;span class=&#34;cl&#34;&gt;    &lt;span class=&#34;nt&#34;&gt;&amp;#34;timestamp&amp;#34;&lt;/span&gt;&lt;span class=&#34;p&#34;&gt;:&lt;/span&gt; &lt;span class=&#34;s2&#34;&gt;&amp;#34;2026-08-02T15:08:41Z&amp;#34;&lt;/span&gt;&lt;span class=&#34;p&#34;&gt;,&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span class=&#34;line&#34;&gt;&lt;span class=&#34;cl&#34;&gt;    &lt;span class=&#34;nt&#34;&gt;&amp;#34;request_id&amp;#34;&lt;/span&gt;&lt;span class=&#34;p&#34;&gt;:&lt;/span&gt; &lt;span class=&#34;s2&#34;&gt;&amp;#34;req-98765&amp;#34;&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span class=&#34;line&#34;&gt;&lt;span class=&#34;cl&#34;&gt;  &lt;span class=&#34;p&#34;&gt;},&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span class=&#34;line&#34;&gt;&lt;span class=&#34;cl&#34;&gt;  &lt;span class=&#34;nt&#34;&gt;&amp;#34;payload&amp;#34;&lt;/span&gt;&lt;span class=&#34;p&#34;&gt;:&lt;/span&gt; &lt;span class=&#34;p&#34;&gt;{&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span class=&#34;line&#34;&gt;&lt;span class=&#34;cl&#34;&gt;    &lt;span class=&#34;nt&#34;&gt;&amp;#34;report_id&amp;#34;&lt;/span&gt;&lt;span class=&#34;p&#34;&gt;:&lt;/span&gt; &lt;span class=&#34;s2&#34;&gt;&amp;#34;REP-2026-001&amp;#34;&lt;/span&gt;&lt;span class=&#34;p&#34;&gt;,&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span class=&#34;line&#34;&gt;&lt;span class=&#34;cl&#34;&gt;    &lt;span class=&#34;nt&#34;&gt;&amp;#34;status&amp;#34;&lt;/span&gt;&lt;span class=&#34;p&#34;&gt;:&lt;/span&gt; &lt;span class=&#34;s2&#34;&gt;&amp;#34;COMPLETED&amp;#34;&lt;/span&gt;&lt;span class=&#34;p&#34;&gt;,&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span class=&#34;line&#34;&gt;&lt;span class=&#34;cl&#34;&gt;    &lt;span class=&#34;nt&#34;&gt;&amp;#34;artifact_url&amp;#34;&lt;/span&gt;&lt;span class=&#34;p&#34;&gt;:&lt;/span&gt; &lt;span class=&#34;s2&#34;&gt;&amp;#34;https://example.com/artifacts/build-report.pdf&amp;#34;&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span class=&#34;line&#34;&gt;&lt;span class=&#34;cl&#34;&gt;  &lt;span class=&#34;p&#34;&gt;}&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;span class=&#34;line&#34;&gt;&lt;span class=&#34;cl&#34;&gt;&lt;span class=&#34;p&#34;&gt;}&lt;/span&gt;
&lt;/span&gt;&lt;/span&gt;&lt;/code&gt;&lt;/pre&gt;&lt;/div&gt;&lt;p&gt;Neste exemplo em &lt;code&gt;JSON&lt;/code&gt;:&lt;/p&gt;
&lt;ul&gt;
&lt;li&gt;&lt;code&gt;metadata&lt;/code&gt; fornece o contexto de transmissão e ambiente (versão, carimbo de data/hora, ID da requisição).&lt;/li&gt;
&lt;li&gt;&lt;code&gt;payload&lt;/code&gt; contém os dados reais da lógica de negócio (ID do relatório, status).&lt;/li&gt;
&lt;li&gt;&lt;code&gt;artifact_url&lt;/code&gt; aponta para o arquivo físico real gerado por esta tarefa de compilação (&lt;code&gt;Artifact&lt;/code&gt;).&lt;/li&gt;
&lt;/ul&gt;
&lt;!--adsense--&gt;
&lt;h2 id=&#34;o-poder-do-vocabulário-compartilhado-ponte-de-comunicação-entre-sistemas&#34;&gt;O Poder do Vocabulário Compartilhado: Ponte de Comunicação Entre Sistemas
&lt;/h2&gt;&lt;p&gt;Quando diferentes ferramentas e equipes adotam esse modelo de dados semelhante (&lt;code&gt;Report&lt;/code&gt; -&amp;gt; &lt;code&gt;Findings&lt;/code&gt; -&amp;gt; &lt;code&gt;Evidence&lt;/code&gt;), os custos de comunicação entre equipes diminuem drasticamente.&lt;/p&gt;
&lt;p&gt;Imagine que o &lt;code&gt;Report&lt;/code&gt; gerado por sua ferramenta de &lt;code&gt;CI/CD&lt;/code&gt; possa ser transmitido diretamente e sem atrito para o sistema de segurança para análise — esse é o poder de integração do idioma de domínio compartilhado.&lt;/p&gt;
&lt;pre class=&#34;mermaid&#34;&gt;
  sequenceDiagram
    autonumber
    actor CI as CI/CD Pipeline
    participant Scanner as Escâner de Segurança
    participant Dashboard as Painel de Controle
    
    CI-&amp;gt;&amp;gt;Scanner: Fornece Manifest para Escanear
    Scanner-&amp;gt;&amp;gt;Scanner: Gera Report e Findings
    Scanner-&amp;gt;&amp;gt;Dashboard: Envia Payload Estruturado (Finding + Evidence)
    Dashboard--&amp;gt;&amp;gt;CI: Exibe Resultados de Auditoría
&lt;/pre&gt;

&lt;h2 id=&#34;resumo&#34;&gt;Resumo
&lt;/h2&gt;&lt;p&gt;Na verdade, o objetivo desses termos é resolver problemas de &lt;strong&gt;comunicação e estruturação de dados&lt;/strong&gt; entre sistemas de grande escala.&lt;/p&gt;
&lt;p&gt;Ao integrar sistemas ou projetar &lt;code&gt;API&lt;/code&gt;, tente incorporar esses conceitos de hierarquia de dados na estrutura do seu &lt;code&gt;Payload&lt;/code&gt;, tornando o design do seu sistema mais profissional e altamente extensível!&lt;/p&gt;
</description>
        </item>
        
    </channel>
</rss>
