{"id":3809,"date":"2020-07-31T23:08:41","date_gmt":"2020-07-31T23:08:41","guid":{"rendered":"http:\/\/r1.ufrrj.br\/petsi\/?p=3809"},"modified":"2020-07-31T23:08:41","modified_gmt":"2020-07-31T23:08:41","slug":"a-importancia-da-documentacao-de-apis-inauguracao-da-secao-de-relatorios-tecnicos","status":"publish","type":"post","link":"https:\/\/r1.ufrrj.br\/petsi\/?p=3809","title":{"rendered":"A Import\u00e2ncia da documenta\u00e7\u00e3o de API\u2019s + inaugura\u00e7\u00e3o da se\u00e7\u00e3o de Relat\u00f3rios T\u00e9cnicos!"},"content":{"rendered":"<p style=\"text-align: justify;\">\u00a0 \u00a0 \u00a0As API&#8217;s (<em>Application Programming Interface)<\/em>\u00a0est\u00e3o sendo cada vez mais utilizadas e exigidas como forma de facilitar e padronizar o desenvolvimento de softwares e aplica\u00e7\u00f5es web, agrupando fun\u00e7\u00f5es e determinadas funcionalidades para que modelos e padr\u00f5es sejam utilizados em projetos diferentes, internos ou externos \u00e0 API.<\/p>\n<p style=\"text-align: justify;\">\u00a0 \u00a0 \u00a0 O PET-SI, por exemplo, possui a API do <a title=\"OpenSoils\" href=\"https:\/\/opensoils.org\/\" target=\"_blank\">OpenSoils<\/a>, que fornece dados\u00a0de perfis e tradagens de solos, al\u00e9m da gera\u00e7\u00e3o de mapas e relat\u00f3rios, tudo a partir do seu celular, direto do campo.<\/p>\n<p style=\"text-align: justify;\">\u00a0 \u00a0 \u00a0 Entretanto, se quis\u00e9ssemos utilizar uma API(como a do OpenSoils), de forma que tudo ocorra de forma fluida, se faz necess\u00e1ria uma documenta\u00e7\u00e3o explicando a forma correta de se utilizar e integrar a API, detalhando suas diferentes rotinas, fun\u00e7\u00f5es e retornos esperados. Atualmente, temos a possibilidade de fazer desta documenta\u00e7\u00e3o algo interativo e bem mais intuitivo, utilizando diferentes ferramentas de gerenciamento de API&#8217;s.<\/p>\n<p style=\"text-align: justify;\">\u00a0 \u00a0 \u00a0 Este tipo de assunto n\u00e3o costuma ser abordado durante a gradua\u00e7\u00e3o de Sistemas de Informa\u00e7\u00e3o, ent\u00e3o, pensando nisso, trouxemos uma novidade ao nosso site: uma se\u00e7\u00e3o de Relat\u00f3rios T\u00e9cnicos, que ficar\u00e1 na nossa aba de publica\u00e7\u00f5es! Por meio destes, buscamos informar a todos que desejam saber mais sobre alguns assuntos interessantes e pouco abordados durante a faculdade, mas que far\u00e3o diferen\u00e7a no mercado.<\/p>\n<p style=\"text-align: justify;\">\u00a0 \u00a0 \u00a0 \u00a0Ent\u00e3o, para inaugurar a se\u00e7\u00e3o de Relat\u00f3rios T\u00e9cnicos, temos o texto &#8220;A Import\u00e2ncia da documenta\u00e7\u00e3o de API\u2019s&#8221;, escrito pela petiana Alexia Duarte. Confira <a title=\"neste link!\" href=\"http:\/\/r1.ufrrj.br\/petsi\/?page_id=627\" target=\"_blank\">neste link<\/a>!<\/p>\n","protected":false},"excerpt":{"rendered":"<p>\u00a0 \u00a0 \u00a0As API&#8217;s (Application Programming Interface)\u00a0est\u00e3o sendo cada vez mais utilizadas e exigidas como forma de facilitar e padronizar o desenvolvimento de softwares e aplica\u00e7\u00f5es web, agrupando fun\u00e7\u00f5es e determinadas funcionalidades para que modelos e padr\u00f5es sejam utilizados em projetos diferentes, internos ou externos \u00e0 API. \u00a0 \u00a0 \u00a0 O PET-SI, por exemplo, possui [&hellip;]<\/p>\n","protected":false},"author":3,"featured_media":3818,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":[],"categories":[1],"tags":[],"_links":{"self":[{"href":"https:\/\/r1.ufrrj.br\/petsi\/index.php?rest_route=\/wp\/v2\/posts\/3809"}],"collection":[{"href":"https:\/\/r1.ufrrj.br\/petsi\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/r1.ufrrj.br\/petsi\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/r1.ufrrj.br\/petsi\/index.php?rest_route=\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/r1.ufrrj.br\/petsi\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=3809"}],"version-history":[{"count":9,"href":"https:\/\/r1.ufrrj.br\/petsi\/index.php?rest_route=\/wp\/v2\/posts\/3809\/revisions"}],"predecessor-version":[{"id":3820,"href":"https:\/\/r1.ufrrj.br\/petsi\/index.php?rest_route=\/wp\/v2\/posts\/3809\/revisions\/3820"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/r1.ufrrj.br\/petsi\/index.php?rest_route=\/wp\/v2\/media\/3818"}],"wp:attachment":[{"href":"https:\/\/r1.ufrrj.br\/petsi\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=3809"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/r1.ufrrj.br\/petsi\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=3809"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/r1.ufrrj.br\/petsi\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=3809"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}