Cloudflare API as a OpenAPI file/export

user39914 · September 25, 2022, 3:46pm

Currently, Cloudflare has a large and often changing API, but there does not seem to be an OpenAPI file/export for it.

The result is that SwaggerHub, Postman and github are full of third party attempts to create language bindings for the API that are out of date and incomplete. From another post on the forums made about 18 months ago it seems that the raw json/yaml was being provided at the API endpoint for at least a short period of time.

cherryjimbo · September 25, 2022, 4:35pm

This now appears to be automated and published here:

github.com

cloudflare/api-schemas/blob/main/openapi.yaml

openapi: 3.0.3
components:
  schemas:
    0rtt:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - 0rtt
            example: 0rtt
          value:
            $ref: '#/components/schemas/0rtt_value'
      title: 0-RTT Value
      description: 0-RTT session resumption enabled for this zone.
    0rtt_value:
      type: string
      description: Value of the 0-RTT setting.
      enum:

This file has been truncated. show original

Do note from the repo though:

Please Note: The schemas in this repository are in a preview state and are not for production use . Expect failures or issues in using the schemas in any way, including OpenAPI tooling at this time. Further updates will be announced via this repository and the Cloudflare blog as things change.

user39914 · September 25, 2022, 5:22pm

Sadly, that is one of the many ‘in part’ attempts to publish the API as an OpenAPI file, rather than a real answer as it covers about 5 endpoints out of 100+ endpoints in the full API.

In many ways it is more an indication of just how much work Cloudflare would have to do to complete such a project and without such work the APIs have to be hand implemented by every developer who wants to use them.

cherryjimbo · September 25, 2022, 5:25pm

Where are you seeing it only covering about 5 endpoints? It’s a >2MB file covering hundreds of them.

https://raw.githubusercontent.com/cloudflare/api-schemas/main/openapi.yaml

user39914 · September 25, 2022, 6:20pm

OK, my mistake Cloudflare structure is a little different to what I am used to and they have not included the tags needed to allow SwaggerHub to display things in a logical way.

While Cloudflare’s docs list APIs as a long list like

Accounts
Accounts Members
Account Roles
Account Subscriptions
…
Zero Trust organization
Access service tokens

They all fall under the URL of /accounts

For anyone who wants to try this with SwaggerHub, it can be imported, but the rendering of the API to a browser needs a lot of memory, my copy of Firefox is currently using 4GB to hold the page. Also, a lot of errors are reported so it is not possible to export to a selected language.