Canvas API and Swagger

Looks like Canvas is using Swagger as the API definition format. and judging by the Live API (https:///doc/api/api-docs.json ) it is using Swagger version 1.2

My question is does anyone know how to generate a (C#) client library based on the API definition from Swagger.

There are some options out there on the Internet like NSwag, but they all work against Swagger 2.0.

I have also tried to convert 1.2 to 2.0 using converter like https://lucybot.github.io/api-spec-converter/ , but that doesnt seem to work either.

thanks

Doug

Find more posts tagged with

Open API

Accepted answers

unknown

Hi @d_tan ,

Great question, this is something I have often wondered myself. @tnijssen , that is handy to know!

Perhaps if this is something that more people would like to see in a future version of the API, logging a feature idea for this would be outstanding. I would suggest leaving the discussion open for a while first, and then collecting all the thoughts into a feature idea, what it would deliver, and how it would benefit all who interact with the API.

Cheers,

Stuart

All comments

unknown

It turns out that Canvas' API specification is just something that looks like Swagger 1.2, but doesn't actually follow the standard.

The farthest I've gotten is converting the Swagger 1.2 spec into something that looks like Swagger 2.0 (but doesn't validate, with unhelpful errors). I hadn't even gotten to the codegen phase yet.

If/when Instructure ever create API v2, maybe they can use Swagger 2.0 (or at least something that actually validates).

matthew_buckett

Is there any plan to update the Canvas API swagger specification to a more recent version?

unknown

Hi @d_tan ,

Great question, this is something I have often wondered myself. @tnijssen , that is handy to know!

Cheers,

Stuart

unknown

Hi @d_tan ,

I wanted to check in and see if the previous answers have given you the information you need? For now I will mark this as assumed answered, however if you have any additional questions, please do not hesitate to jump in and let us know.

Cheers,
Stuart

unknown

I would love to see Swagger 2.0 support in Canvas. Having a Swagger 2.0 spec would allow is to dynamically create clients based on the Swagger documentation.

See:

GitHub - RSuter/NSwag: The Swagger/OpenAPI toolchain for .NET, Web API and TypeScript.

GitHub - Azure/autorest: OpenAPI (f.k.a Swagger) Specification code generator. Supports C#, Go, Java, Node.js, TypeScrip…

matthew_buckett

There was a hint from Simon Williams(Instructure) at Intrusturecarn this year that they are looking at supporting OpenAPI (upgraded and renamed Swagger API) in the future, although because their API has evolved over time, rather then being designed with Swagger/OpenAPI in mind this isn't a simple/easy process. The video of this is here:

https://www.canvaslms.com/instructurecon/video/2018/?video=mun6emoc1u

I've managed to generate a client by upgrading the Swagger 1.2 spec to 2.0 and then tweaking it. But it needs quite a bit of tweaking to get a working client and then this progress has to be repeated when the API is changed.

dtod

I filed a Feature Request that I hope captures this - https://community.canvaslms.com/ideas/13768-api-in-openapi-format

unknown

Ok so I know how to make this work but its on an API by API basis, not the whole lot at once.

go to https:// Canvas DNS>/doc/api/api-docs.json

Find the API you want in the list and cut and paste the path to replace "/api-docs.json" i.e. for users it becomes

https:// Canvas DNS>/doc/api/users.json

Cut and paste that URL into Postmap Import -> "Import from link"

This will generate a Valid API collection with a couple of limitations. All the URL's are "canvas.instructure.com" and it will import all the API's related to that. The "user" collection for example contains EVERYTHING to do with the user even if in api.instructure.com its listed under another object. There also appears to be undocumented API's in here I think, haven't looked closely at it yet

Unanswered Questions

Web bug... not sure where to report.
Rendering bug here: Canvas - Instructure Community Seems to only appear in Edge; fine in Chrome and Firefox https://us.v-cdn.net/6038536/uploads/W3BKB9LY5FCV/recording-2026-04-08-144351.mp4
Obtaining access token using developer key for server-to-server REST API access
I have a developer key in our Test instance: How would I use this in a local program to make a REST API call? Looking at https://developerdocs.instructure.com/services/canvas/oauth2/file.developer_keys: Developer keys are OAuth2 client ID and secret pairs stored in Canvas that allow third-party applications to request…
Finding the LTIv1.3 IDs for Members of a Course
I'm building a tool for my institution that imports grades from another LTI tool into Canvas so instructors can automate late assignment policies not otherwise supported by Canvas. I'm trying to use the LTIv1.3 ID which is readily available on the LTI-side as a link to the student record on Canvas, but I can't find the ID…
Canvas Media Question
How can one track Canvas Media use without having the reports available from Canvas Studio? Checking API endpoints and the Data 2 schema, there do not seem to be dedicated Canvas Media endpoints. Am I missing some? A method I've considered is using the body field of the wiki_pages table, as this contains the html code of…
Canvas Catalog API - Completed Certificates
Hello, I'm trying to utilize an API call to pull completed certificates and was hoping to download and store the certs as a backup. I can successfully run the API call but it will not allow me to view the certificate unless I access the URL while signed into an account where it's "my" cert. Is there a permissions setting…