Ei! Como fornecedor de API (Ingrediente Farmacêutico Ativo), muitas vezes me perguntam o que é um esquema de API. Então, pensei em levar algum tempo para dividi -lo para você de uma maneira fácil de entender.
Vamos começar com o básico. Um esquema de API é como um plano para uma API. É uma descrição detalhada de como uma API funciona, que dados espera e quais dados eles retornarão. Pense nisso como um conjunto de regras e diretrizes que o provedor da API (sou eu!) Como o consumidor da API (é você ou sua equipe) precisam seguir para garantir uma comunicação suave e eficiente.
Por que um esquema de API é importante?
Bem, imagine que você está construindo uma casa. Você não começaria a jogar tijolos sem um plano, certo? O mesmo vale para APIs. Um esquema de API fornece uma maneira clara e consistente para os desenvolvedores entenderem e usarem a API. Ajuda a evitar mal -entendidos, reduz as chances de erros e facilita a integração da API em diferentes aplicativos.
Por exemplo, digamos que você seja um desenvolvedor que deseja usar nossa API para acessar informações sobreNióbio nano-carbonizado, carboneto de micron niobium, carboneto de nióbio ultra-fino, HFC. O esquema da API informará exatamente quais pontos de extremidade estão disponíveis, quais parâmetros você precisa passar e em que formato a resposta estará. Isso facilita muito a gravação do código para interagir com a API e obter os dados necessários.
O que há em um esquema de API?
Um esquema de API normalmente inclui os seguintes componentes:
1. Pontos de extremidade
Estes são os URLs que você pode ligar para acessar a funcionalidade da API. Cada terminal representa uma operação específica, como obter uma lista de produtos, criar um novo pedido ou atualizar as informações do usuário.
2. Formatos de solicitação e resposta
O esquema definirá o formato dos dados que você precisa enviar suas solicitações (por exemplo, JSON, XML) e o formato dos dados que a API retornará em suas respostas. Isso garante que o provedor da API e o consumidor estejam na mesma página quando se trata de manuseio de dados.
3. Parâmetros
Esses são os valores que você pode passar para um terminal para personalizar a operação. Por exemplo, você pode passar um ID do produto para obter informações sobre um produto específico ou um intervalo para filtrar uma lista de pedidos.
4. Manuseio de erros
O esquema também descreverá como a API lidará com erros. Ele definirá os códigos de erro que a API pode retornar e o que cada código significa. Isso ajuda os desenvolvedores a entender o que deu errado quando ocorre um erro e como corrigi -lo.
Tipos de esquemas de API
Existem vários tipos de esquemas de API, cada um com suas próprias vantagens e casos de uso. Alguns dos mais comuns incluem:
Especificação OpenAPI (OEA)
Este é um dos padrões mais populares para documentar APIs RESTful. Ele usa um arquivo YAML ou JSON para descrever os pontos de extremidade da API, formatos de solicitação e resposta, parâmetros e muito mais. A OEA é amplamente suportada por ferramentas e estruturas, facilitando a geração de documentação, SDKs e casos de teste.
Esquema GraphQL
O GraphQL é um idioma de consulta para APIs que permite que os clientes solicitem exatamente os dados de que precisam. Um esquema GraphQL define os tipos de dados que a API pode retornar e as operações que podem ser executadas nesses tipos. Ele fornece uma maneira mais flexível e eficiente de acessar dados em comparação com as APIs RESTful tradicionais.
Buffers de protocolo
Os buffers de protocolo (Protobuf) são um formato de serialização binário agnóstico da linguagem desenvolvido pelo Google. Ele usa um arquivo de esquema para definir a estrutura dos dados que serão serializados e desserializados. O Protobuf é conhecido por seu alto desempenho e tamanho de mensagem pequena, tornando -o uma escolha popular para APIs que precisam lidar com grandes quantidades de dados.
Como usamos esquemas de API como fornecedor de API
Como fornecedor de API, contamos com esquemas de API para garantir que nossas APIs sejam fáceis de usar e integrar. Utilizamos a especificação OpenAPI para documentar nossas APIs, o que nos permite fornecer documentação clara e detalhada para nossos clientes. Esta documentação inclui informações sobre os pontos de extremidade, formatos de solicitação e resposta, parâmetros e manuseio de erros.
Também usamos esquemas de API para validar as solicitações que recebemos de nossos clientes. Ao verificar as solicitações recebidas em relação ao esquema, podemos garantir que os dados estejam no formato correto e que todos os parâmetros necessários estejam presentes. Isso ajuda a evitar erros e garante que nossas APIs sejam confiáveis e seguras.
Além disso, usamos esquemas de API para gerar SDKs e casos de teste. Usando ferramentas que suportam a especificação OpenAPI, podemos gerar automaticamente código em diferentes linguagens de programação, o que facilita a integração de nossos clientes em seus aplicativos. Também usamos o esquema para gerar casos de teste, o que nos ajuda a garantir que nossas APIs estejam funcionando corretamente e que elas atendam aos requisitos de nossos clientes.
Exemplos do mundo real
Vamos dar uma olhada em alguns exemplos do mundo real de como os esquemas de API são usados.
Exemplo 1: Usando nossa API para obter informações sobreTioxanten-9-one de alta qualidade: 492-22-8
Suponha que você seja um pesquisador que procura obter informações sobre um composto químico específico. Você pode usar nossa API para acessar dados como propriedades do composto, métodos de síntese e informações de segurança. O esquema da API dirá exatamente o que termina para chamar, quais parâmetros passarem (por exemplo, o número do CAS) e em que formato a resposta estará.
Aqui está um exemplo de solicitação à nossa API usando CURL:
Curl -x Get "https://api.oursite.com/compounds/492-22-8" -h "Aceitar: Application/json"A resposta pode parecer algo assim:
{"name": "tioxanthen-9-one", "Cas_number": "492-22-8", "molecular_weight": 212.26, "Propriedades": {"Melting_Point": "85-87 ° C", "FILILING_POINT_POINTE," 365.7 ° C em 760 Reaja x com y na presença de z ... "," Método 2: use as seguintes condições de reação ... "]}Exemplo 2: Criando um novo pedido paraCAS No.455943-61-0 FUNDO GRANDE
Se você é uma empresa farmacêutica que procura fazer um pedido para um grande suprimento de uma API específica, pode usar nossa API para criar um novo pedido. O esquema da API definirá o endpoint para criar um pedido, o formato de solicitação (por exemplo, os detalhes do pedido, a quantidade e o endereço de entrega) e o formato de resposta (por exemplo, o ID do pedido e a mensagem de confirmação).
Aqui está um exemplo de solicitação à nossa API usando Python:
Importar solicitações url = "https://api.oursite.com/orders" dados = {"product_id": "455943-61-0", "Quantity": 1000, "Delivery_address": "123 main st, anytown, EUA"}}} {".s-Type "": JSON: JSON/JSOWN/" Cabeçalhos = cabeçalhos) print (Response.json ())A resposta pode parecer algo assim:
{"Order_id": "123456", "Mensagem": "Ordem criada com sucesso. Seu pedido será processado dentro de 24 horas". }Conclusão
Em conclusão, um esquema de API é uma parte crucial de qualquer API. Ele fornece uma maneira clara e consistente para os desenvolvedores entenderem e usarem a API, reduz as chances de erros e facilita a integração da API em diferentes aplicativos. Como fornecedor de API, contamos com esquemas de API para garantir que nossas APIs sejam fáceis de usar, confiáveis e seguras.
Se você estiver interessado em usar nossas APIs para acessar informações sobre nossos produtos ou fazer pedidos, gostaríamos de ouvir de você. Seja você um pesquisador, uma empresa farmacêutica ou um desenvolvedor, nossas APIs podem fornecer os dados e funcionalidades necessários. Portanto, não hesite em nos alcançar para discutir seus requisitos e iniciar o processo de compras. Estamos aqui para ajudá -lo a aproveitar ao máximo nossas APIs e garantir que sua experiência conosco seja positiva.
Referências
- Fielding, RT (2000). Estilos arquitetônicos e o design de arquiteturas de software baseadas em rede. Universidade da Califórnia, Irvine.
- Khare, R. & Frystyk, H. (1997). Protocolo de transferência de hipertexto - http/1.1. RFC 2068.
- Lindley, S. & Miller, B. (2015). GraphQL: uma linguagem de consulta de dados. Facebook.
- Varda, A. (2008). Buffers de protocolo: formato de intercâmbio de dados do Google. Blog de código aberto do Google.
