Lançamento da Especificação da OpenAPI em Beta da Twilio

Tempo de leitura: 2 minutos

April 19, 2021

Escrito por

Gareth Paul Jones

Twilion

Revisado por

Shawn Stern

Contribuidor

Diane Phan

Twilion

Jon Davis

Twilion

Lançamento da Especificação da OpenAPI em Beta da Twilio

Esteja você criando seu primeiro produto com a Twilio ou procurando expandir sua oferta de produtos, você precisa de acesso fácil a ferramentas nas linguagens de programação ou ambientes mais usados. Hoje, temos o prazer de anunciar que temos a Especificação da OpenAPI de código aberto em Beta para cada API da Twilio.

Por muito tempo, prestamos suporte e mantivemos bibliotecas de ajuda e ferramentas em várias linguagens e ambientes mais populares usados pelos desenvolvedores. Agora, estamos expandindo essa cobertura fornecendo arquivos de documentação de acordo com a Especificação da OpenAPI, um formato padrão do setor para APIs. Assim fica mais simples gerar o código automaticamente para que você possa desenvolver com a Twilio sem complicações, seja qual for a linguagem ou a ferramenta usada.

O que você pode fazer com o OpenAPI?

Geração da biblioteca do cliente

Com o poder da Especificação OpenAPI da Twilio e do gerador de OpenAPI de código aberto, você pode criar novas bibliotecas de cliente. Assim, fica muito mais prático e simples usar a Twilio na linguagem de programação de sua preferência, sem escrever métodos e funções complexas. Por exemplo, agora é possível criar sistematicamente uma biblioteca Rust fortemente tipada para os métodos de API da Twilio.

use dotenv;
use std::env;
use openapi::apis::{configuration::Configuration, default_api as twilio_api};

#[tokio::main]
async fn main() {
  dotenv::dotenv().expect("Failed to read .env file");
  let account_sid = env::var("TWILIO_ACCOUNT_SID").expect("Failed to parse Account SID");
  let api_key = env::var("TWILIO_API_KEY").expect("Failed to parse API Key");
  let api_key_secret = env::var("TWILIO_API_KEY_SECRET").expect("Failed to parse API Key Secret"); 

  let mut twilio_config = Configuration::default();
  // Supply Basic Auth credentials.
  twilio_config.basic_auth = Some((api_key, Some(api_key_secret)));

  let balance = twilio_api::fetch_balance(&twilio_config, &account_sid)
    .await
    .unwrap();

  println!("{:?}", balance);
}

Para saber mais sobre a geração de bibliotecas auxiliares, consulte nosso Boilerplate Gerador de Projetos com OpenAPI no GitHub ou os documentos da Twilio sobre geração de biblioteca de auxiliares.

Teste simulado

Com a Especificação do OpenAPI, você agora pode simular a API da Twilio para emular localmente chamadas reais de API, o que torna a integração do conjunto de testes com a Twilio mais rápida e menos frágil.

Por exemplo, agora você pode facilmente criar um servidor de simulação da API da Twilio portátil com o Docker.

# Dockerfile
# Choose the base image for us to build from.
FROM alpine

# Install dependencies.
RUN apk update && \
 apk add --update git && \
 apk add --update npm && \
 npm i -g @stoplight/prism-cli

# Clone the Twilio OpenAPI spec.
RUN git clone https://github.com/twilio/twilio-oai.git

# Perform preprocessing on the v2010 spec JSON file.
RUN sed -i.bak '/pattern:/d' ./twilio-oai/spec/json/twilio_api_v2010.json && \
 sed -i.bak 's/</Before/' ./twilio-oai/spec/json/twilio_api_v2010.json && \
 sed -i.bak 's/>/After/' ./twilio-oai/spec/json/twilio_api_v2010.json

# Expose the port that Prism runs on.
EXPOSE 4010

# Run Prism!
CMD ["prism", "mock", "-h", "0.0.0.0", "./twilio-oai/spec/json/twilio_api_v2010.json"]

Para saber mais sobre testes simulados, consulte nossa documentação.

Suporte do Postman

Também adicionamos suporte para o Postman, que é uma ferramenta de desenvolvimento gratuita e direta para fazer chamadas de API com uma variedade de recursos úteis. Em vez de consultar os documentos da Twilio e criar sua própria coleção, você pode visitar a página de Coleções da Twilio no Postman, onde encontrará coleções mantidas pela equipe da Twilio. Você também pode navegar visualmente pelas usando o Postman.

Acesse nossa documentação para saber mais sobre o uso das Coleções Postman da Twilio.

Coleção no Postman da Twilio Messaging / SMS

Experimente!

Estamos ansiosos para ver todas as coisas incríveis que você criará com a Especificação da OpenAPI da Twilio! 🚀

Este artigo foi traduzido do original "Introducing Twilio’s OpenAPI Specification Beta". Enquanto melhoramos nossos processos de tradução, adoraríamos receber seus comentários em help@twilio.com - contribuições valiosas podem render brindes da Twilio.

Publicações relacionadas

Recursos relacionados

Twilio Docs

De APIs a SDKs e aplicativos de amostra

Documentação de referência de API, SDKs, bibliotecas auxiliares, guias de início rápido e tutoriais para sua linguagem e plataforma.

Centro de Recursos

Os mais recentes e-books, relatórios do setor e webinars

Aprenda com especialistas em engajamento do cliente para melhorar sua própria comunicação.

Ahoy

Centro da comunidade de desenvolvedores da Twilio

Melhores práticas, exemplos de código e inspiração para criar comunicações e experiências de engajamento digital.