Controlling API names

[ppKrauss]

English

.. translate please

Portuguese

É necessário regrar um pouco melhor a oferta de APIs de cada domínio... Sugere-se mais ou menos o seguinte:

1. API implementada por um período de teste em modo teste, para comprovar que não tem "efeitos colaterais" no servidor, e que contempla ambos, a especificação técnica inicial e as necessidades reais de quem usa.

2. Controle dos nomes de API através de versionamento e jurisdição. Por exemplo a API do batista seria versão 1 (v1) da Colômbia, então o nome seria algo como API.addressforall.org/v1/CO/search

3. Controle interno dos nomes de função no PostgreSQ/PostgREST, dentro do SQL-schema API: o acesso GET e POST se faz no NGINX por algo como
   proxy_pass http://localhost:$porta/rpc/uridisp_$1_$2?p_uri=$3&$args onde $1 é o módulo funcional (ex. addressfind), $2 o nome da API (ex. search), $3 o parâmetro default contendo o "resto do path na URL" e em $args os demais parâmetros, quando houverem. A declaração de função será sempre seguindo o template CREATE FUNCTION api.uridisp_{module}_{name}(p_uri text, {args}) RETURNING jsonb .... IMMUTABLE.

Nesta issue discutiremos diretamente o draft da documentação e a sua implementação final.

[0e1]

Levei o conteúdo dessa discussão para AddressForAll/WS#11 (comment).