メニュー

Expand
ページを評価:

Mock API Generation with Twilio's OpenAPI Spec

The Twilio OpenAPI Spec is currently in BETA. The spec is expected to be accurate, but is currently in active development and is unsupported. If you've identified a mismatch between Twilio's API behavior and the specification, please open an issue.

Thanks to the rollout of Twilio’s OpenAPI specification, it is now possible to mock Twilio’s API locally and in your CI environments. Using a mock can save you time and money during development and testing.

What is a mock API server?

A mock API server allows you to emulate a real API (such as Twilio) locally, in your test environments, and/or even publicly. This mock server can receive requests, and will respond to them with static or dynamic data that simulates what the real API would return.

Why use a mock API server?

Developing and/or testing against a mock API server has a litany of benefits, including but not limited to:

  • Testing against Twilio costs money per request, while testing the same requests against a mock are effectively free.
  • A mock API server is typically stateless, so you can repeatedly test the same scenario and expect consistent results.
  • A locally running mock API server will have substantially faster response times than a live API service, which can add up to time savings both in local dev and especially for lengthy test suites. This will also allow you to develop while not connected to the internet, or in a situation where workplace policies may prevent your machine from connecting to Twilio.
  • A mock API server can simulate the behavior of endpoints which are still under development or in a private beta before they’ve been released, unblocking your own development process

Additionally, because the mock server in this example will be generated using Twilo’s OpenAPI Specification, each endpoint will validate requests and return data in the same format as the live Twilio API.

If you’re interested in taking advantage of these benefits, let’s proceed and learn how to set up the mock.

Mocking Twilio with the OpenAPI Specification and Prism

前提条件

  • A javascript package manager, such as npm or yarn

はじめよう

In order to generate a mock server from Twilio’s OpenAPI specification, you will use the open source tool, Prism.

What is Prism? According to the Prism documentation:

Prism is an open-source HTTP mock server that can mimic your API’s behavior as if you already built it. Mock HTTP servers are generated from your OpenAPI v2/v3 (formerly known as Swagger) documents.

Install Prism using your preferred package manager as shown below:

npm install -g @stoplight/prism-cli

# OR

yarn global add @stoplight/prism-cli

Running the mock API server with Prism

Now that Prism is installed, the next step is to feed a specification file to Prism so that it can generate the desired mock API server. Run the following command:

prism mock https://raw.githubusercontent.com/twilio/twilio-oai/main/spec/json/twilio_api_v2010.json

Note that we’re referencing the JSON spec files in our examples. It’s also perfectly valid to use the YAML files instead, but for the sake of this article we will only be focusing on JSON.

After a short time you will see a trace similar to below. Once you see the green start line the server is running and listening for requests on the displayed port on localhost. Congratulations on starting your (maybe first) Prism mock server!

$ prism mock https://raw.githubusercontent.com/twilio/twilio-oai/main/spec/json/twilio_api_v2010.json

 [CLI] ...  awaiting  Starting Prism...
 [CLI] i  info      GET        http://127.0.0.1:4010/2010-04-01/Accounts.json?FriendlyName=omnis&Status=suspended&PageSize=801
 [CLI] i  info      POST       http://127.0.0.1:4010/2010-04-01/Accounts.json
 [CLI] i  info      GET        http://127.0.0.1:4010/2010-04-01/Accounts/ACbC8dB063DcfAe78a6D0cfEb09e0c7c7a/Addresses.json?CustomerName=doloribus&FriendlyName=porro&IsoCountry=necessitatibus&PageSize=325
...
 [CLI] i  info      GET        http://127.0.0.1:4010/2010-04-01/Accounts/ACF5ce8F97eb3E0270a856d8539e61DAE5.json
 [CLI] i  info      POST       http://127.0.0.1:4010/2010-04-01/Accounts/AC61FCB0720E02eCAf7fEeCbafEa602aE5.json
 [CLI]   start     Prism is listening on http://127.0.0.1:4010

Testing the mock API's validation layer

To validate that this is working as expected, let’s make some requests to the mock using curl in various forms to see some features of the mock in action.

First, leave the Prism mock server running in the terminal, and open a new tab or window depending on what’s allowed by your terminal. In the new terminal instance, let’s start with the example of querying the Twilio API for a list of messages sent by your account. If we try the following command and forget to include credentials, we will get the following error:

curl -s -D "/dev/stderr" http://127.0.0.1:4010/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json | json_pp

Which will result in:

HTTP/1.1 401 Unauthorized
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: *
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: *
content-type: application/problem+json
WWW-Authenticate: Basic realm="*"
Content-Length: 327
Date: Wed, 31 Mar 2021 18:41:14 GMT
Connection: keep-alive
Keep-Alive: timeout=5

{
   "headers" : {
      "WWW-Authenticate" : "Basic realm=\"*\""
   },
   "title" : "Invalid security scheme used",
   "detail" : "Your request does not fullfil the security requirements and no HTTP unauthorized response was found in the spec, so Prism is generating this error for you.",
   "status" : 401,
   "type" : "https://stoplight.io/prism/errors#UNAUTHORIZED"
}

Also, if you take a peek at the Prism terminal instance, you will see some validation errors as below:

 [HTTP SERVER] get /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json i  info      Request received
     [NEGOTIATOR] i  info      Request contains an accept header: */*
     [VALIDATOR]   warning   Request did not pass the validation rules
     [NEGOTIATOR]   debug     Unable to find a  response definition
     [NEGOTIATOR]   debug     Unable to find a 'default' response definition
 [HTTP SERVER] get /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json   error     Request terminated with error: https://stoplight.io/prism/errors#UNAUTHORIZED: Invalid security scheme used

Notice here that the mock API server is actually validating the content of our request as the real Twilio API would, and is throwing a 401 error since credentials were not included in the request headers. Let’s fix that and try again once we’ve set some environment variables for Twilio credentials

export TWILIO_ACCOUNT_SID=AC...
export TWILIO_AUTH_TOKEN=...

curl -s -D "/dev/stderr" http://127.0.0.1:4010/2010-04-01/Accounts/MockSID/Messages.json -u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN | json_pp

And the result will be:

HTTP/1.1 422 Unprocessable Entity
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: *
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: *
content-type: application/problem+json
Content-Length: 508
Date: Wed, 31 Mar 2021 18:41:43 GMT
Connection: keep-alive
Keep-Alive: timeout=5

{
   "title" : "Invalid request",
   "detail" : "Your request is not valid and no HTTP validation response was found in the spec, so Prism is generating this error for you.",
   "status" : 422,
   "validation" : [
      {
         "message" : "should NOT be shorter than 34 characters",
         "severity" : "Error",
         "code" : "minLength",
         "location" : [
            "path",
            "accountsid"
         ]
      },
      {
         "code" : "pattern",
         "location" : [
            "path",
            "accountsid"
         ],
         "message" : "should match pattern \"^AC[0-9a-fA-F]{32}$\"",
         "severity" : "Error"
      }
   ],
   "type" : "https://stoplight.io/prism/errors#UNPROCESSABLE_ENTITY"
}

Note that this time the mock API server successfully validated the Account SID (in this case, MockSID) and found that it failed validation due to being the wrong length and for including invalid characters. The mock is doing a great job of emulating the real Twilio API so far!

Creating a successful request against the mock API server

If we cut the shenanigans and give the mock API server valid input and see what happens. Run the following command:

curl -s -D "/dev/stderr" http://127.0.0.1:4010/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json -u $TWILIO_ACCOUNT_SID:$TWILIO_AUTH_TOKEN | json_pp

and the output will be:

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Headers: *
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: *
Content-type: application/json
Content-Length: 551
Date: Wed, 31 Mar 2021 18:43:18 GMT
Connection: keep-alive
Keep-Alive: timeout=5

{
   "uri" : "http://example.com",
   "next_page_uri" : "http://example.com",
   "start" : 0,
   "first_page_uri" : "http://example.com",
   "messages" : [
      {
         "account_sid" : null,
         "num_segments" : null,
         "uri" : null,
         "subresource_uris" : null,
         "to" : null,
         "direction" : "inbound",
         "body" : null,
         "status" : "queued",
         "num_media" : null,
         "messaging_service_sid" : null,
         "api_version" : null,
         "error_code" : null,
         "from" : null,
         "error_message" : null,
         "date_updated" : null,
         "date_sent" : null,
         "date_created" : null,
         "sid" : null,
         "price_unit" : null,
         "price" : null
      }
   ],
   "previous_page_uri" : "http://example.com",
   "page_size" : 0,
   "page" : 0,
   "end" : 0
}

Success! This caused the mock server to return a 200 status as well as a JSON representation of a messages sent record. The Prism terminal instance should also reflect this success as shown:

 [HTTP SERVER] get /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json i  info      Request received
     [NEGOTIATOR] i  info      Request contains an accept header: */*
     [VALIDATOR]   success   The request passed the validation rules. Looking for the best response
     [NEGOTIATOR]   success   Found a compatible content for */*
     [NEGOTIATOR]   success   Responding with the requested status code 200

Now that we’ve validated the mock API server is running and acting as expected, the next step is to make it so that our applications can communicate with the mock instead of sending requests to Twilio during development and testing.

Connecting applications to the Prism mock server

In order for you to leverage the Prism mock server during development of your application code, your Twilio client will need to be configured to redirect requests to the mock instead of Twilio itself. We’ll demonstrate how to accomplish this in Node.js below, but note that this is supported by all of the Twilio SDKs.

As mentioned in the Twilio Node documentation on custom HTTP clients, it’s possible to extend the behavior of the Twilio client by creating and passing in a custom implementation of the httpClient property. This is a perfect point in the codebase to add some code that will intercept requests and redirect them to the mock.

Starting from within a new empty directory, create a file for housing your custom Request Client. In this case let’s call it PrismClient.js.

Next, add the following example code:

        
        
        

        This PrismClient has a few key points:

        • It is constructed using a url for the locally running Prism instance as well as the existing Twilio RequestClient. Relying on the existing client means we can focus only on our custom behavior and not worry about fully re-creating the client.
        • The request method uses a regular expression to change the url of any request intended for Twilio to instead hit the same relative path, but on the Prism server instead.

        To use this new client, let's create an index.js in the same directory that sends a new SMS Message. Additionally, let's make sure the necessary dependencies are also available, such as the Twilio Node SDK:

        yarn init -y
        # Or if you prefer npm
        npm init -y
        
        # Once initialized, install dependencies!
        yarn add twilio dotenv
        # Or with npm
        npm i twilio dotenv
        
        # Create a new js file as well as a safe file for credentials and other sensitive variables to live in
        touch index.js .env
        

        Next, paste the following example code into index.js

              
              
              

              Note that we’re using best practices here, and creating the Twilio client using an API Key and Secret instead of directly using and potentially exposing your account’s auth token. If you’d like to learn more about API Keys and how to create one, please refer to the API Keys documentation!

              There are a few important things happening here of note:

              • This snippet is importing twilio, the custom PrismClient that we just created earlier, and destructuring out twilios internal RequestClient.
              • After declaring all variables being pulled in from the environment, we’re creating a new Twilio client using account credentials, and more importantly providing a custom httpClient as an option. The first argument is the url and port of the locally running Prism server, and the second is the Twilio RequestClient that was imported earlier.
              • Finally, we’re using this client to create and send an ‘Ahoy!’ SMS to the provided number. Once the message is queued, a log will be printed to the terminal along with the SID of that message (or we’ll safely catch and log just in case there’s some kind of error)

              Similarly, add the following variables to your .env file, being sure to use your own valid Account SID, API Key, Key Secret, and Twilio/Personal phone numbers.

              # .env
              TWILIO_ACCOUNT_SID=ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
              TWILIO_API_KEY=SKXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
              TWILIO_API_SECRET=ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
              TO_NUMBER=+12345678901
              FROM_NUMBER=+12345678901
              

              Execute the example code by running node index.js.

              Once execution completes, you’ll see the following in your terminal:

              $ node example.js
              Message null sent!
              

              Don’t be alarmed by the null, this is simply a result of Prism successfully intercepting the request and returning null for the message sid!

              If you switch over to the terminal that is running Prism, you will see logs indicating a successful request/response cycle from Prism that returned a 201:

               [HTTP SERVER] post /2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages.json i  info      Request received
                   [NEGOTIATOR] i  info      Request contains an accept header: application/json
                   [VALIDATOR]   success   The request passed the validation rules. Looking for the best response
                   [NEGOTIATOR]   success   Found a compatible content for application/json
                   [NEGOTIATOR]   success   Responding with the requested status code 201
              

              This is an example of being able to run your code locally and verify that your integration with Twilio is correct. Note that the request to create and send an SMS never reached Twilio (you shouldn’t have received a text!), and instead was quickly and safely redirected to the mock instead.

              If your code uses the .list or .each methods that are available (such as client.messages.list(), running your code against the mock will cause it to throw an error. This is because the mocked next_page_uri value will be http://example.com, which will cause the request to 404 against Prism.

              If your application makes calls to other subdomains than api.twilio.com, this mocking solution will not intercept calls to those other subdomains yet. It’s possible to duplicate this process for other files one at a time (for example, mocking for accounts.twilio.com but not api.twilio.com), however we are still developing a solution to allow mocking for multiple subdomains at once.

              Making the mock server more portable with Docker

              If you want to share this mock with other developers on your team without the need for them to install Stoplight, or make it easily reproducible in another environment such as your CI pipeline, running it as a Docker container is highly advised. If you do not have Docker already installed, you can download and install it from here.

              Creating and running Stoplight using Docker

              To run the previous mock API server using the Stoplight Docker image instead of the Stoplight CLI, run the following example command. Be sure to end any previously running Prism processes, otherwise the port will already be taken and the Docker container will fail to start:

              docker run --init -d -p 4010:4010 stoplight/prism:4 mock -h 0.0.0.0 https://raw.githubusercontent.com/twilio/twilio-oai/main/spec/json/twilio_api_v2010.json
              

              Once the Docker container is built (it may take some time depending on connection speeds), it will begin running and accepting requests on localhost:4010 just as before with the CLI.

              You can verify that your container is running using the following command and looking for the stoplight/prism:4 image as below:

              docker ps
              

              You may also leverage the Docker Dashboard for a GUI-based way of viewing the running container and its logs.

              Now that you have a successfully running, Dockerized version of the Prism mock it’s time to verify it is working as expected. Run the node example again via `node example.js`, and once again you should see:

              $ node example.js
              Message null sent!
              

              If you consult the Docker Dashboard for your container, you should see logs indicating that a message request was received and that a 201 was returned, just as we saw for the non-Dockerized version of Prism.

              When you want to stop your container, first list out the running Docker images, then identify either the Container ID or Name of the running Prism container.

              $ docker ps
              CONTAINER ID   IMAGE               COMMAND                  CREATED         STATUS         PORTS                                       NAMES
              c1f2b80c13ae   stoplight/prism:4   "node dist/index.js ..."   3 seconds ago   Up 2 seconds   0.0.0.0:4010->4010/tcp, :::4010->4010/tcp   youthful_banzai
              

              In this example, you could use either of these commands to stop the container:

              # Using the ID
              docker stop c1f2b80c13ae
              # Using the Name
              docker stop youthful_banzai
              

              Simplify running the Dockerfile with Docker Compose

              If you’d like to further abstract away the process of building and running the Stoplight Docker image, you have the option of configuring and using Docker Compose to simplify the process and reduce friction for other team members.

              First, create a new docker-compose.yml file:

              touch docker-compose.yml
              

              and paste in the following contents:

              # docker-compose.yml
              version: '3'
              services:
                prism:
                  image: stoplight/prism:4
                  ports:
                    - '4010:4010'
                  command: mock -h 0.0.0.0 https://raw.githubusercontent.com/twilio/twilio-oai/main/spec/json/twilio_api_v2010.json
              

              You can now run the Dockerized Prism container with an even shorter command:

              docker-compose up -d
              # compare to:
              # docker run --init -d -p 4010:4010 stoplight/prism:4 mock -h 0.0.0.0 https://raw.githubusercontent.com/twilio/twilio-oai/main/spec/json/twilio_api_v2010.json
              

              The Docker container will now be running and accessible on localhost:4010 just as before, and you can run the node example (node example.js) once more to verify.

              Sharing your Docker setup

              Now that you have Docker set up in this way, you could commit the docker-compose.yml file to version control alongside the project(s) that leverage these files for testing within your team or organization.

              ページを評価:

              ヘルプが必要ですか?

              誰しもが一度は考える「コーディングって難しい」。そんな時は、お問い合わせフォームから質問してください。 または、Stack Overflow でTwilioタグのついた情報から欲しいものを探してみましょう。

              フィードバックくださりありがとうございます!

              We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              Refer us and get $10 in 3 simple steps!

              ステップ1

              Get link

              Get a free personal referral link here

              ステップ2:

              Give $10

              Your user signs up and upgrade using link

              ステップ3

              Get $10

              1,250 free SMSes
              OR 1,000 free voice mins
              OR 12,000 chats
              OR more