Swagger OpenAPI Fundamentals

Create a Swagger Hub account on the Swagger website, choose the free plan, and sign in with GitHub or a company account to access My Hub and APIs.

Explore the Swagger Hub hierarchy—APIs, domains, organizations, projects, and teams—and how individuals or organizations manage and assign APIs across projects and teams.

Import an existing api into swagger hub, choosing owner and visibility, upload yaml or json files, validate the import, and view the open api in the swagger editor.

Create a new open API from scratch in Swagger Hub by entering name, version, title, and description, choosing version 3.0.0, visibility, and optionally enabling mock or using a template.

Add the OpenAPI version to a new document, verify 3.0.0 in Swagger UI, and adjust the version in the code editor while honoring the mandatory OpenAPI tag before adding information.

Configure the Swagger OpenAPI info metadata by entering title, description, version, terms of service, contact, and license via code or visual editors.

Add external docs to your API by entering the external documentation and a documentation URL to provide more information for third-party systems, such as CMS API.

Define and manage open API servers by adding production and staging server entries, configuring address formats with host and port variables, and saving changes to generate dynamic server addresses.

Add tags to your open API document to group operations, create a new tag like course, optionally describe it and provide external docs, then save and continue to define paths.

Define paths and operations in an OpenAPI document, starting with /courses, including summary and description, and switch to the code editor when the visual editor lacks path support.

Fix a duplicate path error in swagger editor. Add a get operation to the courses path that returns all courses, with tags, summary, and operation ID.

Add a sort by parameter to the courses get operation, define it as a query parameter with an enum of ascending or descending and a default.

Add a responses section to the get operation, returning a json array of course objects on 200 with a course schema, including id, name, duration, and type.

Define a post operation to add a new course, configure a request body with a course schema in application/json, and return the added course with a 201 status.

Learn how to create reusable components in an open API document by moving types like course into the components section and referencing them with $ref across schemas and responses.

Define security schemes in the components for basic and bearer authentication, apply them globally with the security keyword, and override per operation when needed.

Demonstrates adding a path for a single course item and defining get, put, and delete operations with path parameters, a request body, and responses in Swagger Hub.

Publish an API when ready for production by selecting a version and confirming the publish action; once published, the API becomes read-only, and changes require unpublishing or a new version.

Learn to version an API in Swagger Hub by creating new versions like 1.1 instead of editing 1.0, and manage default versions to protect third-party integrations.

Learn to delete an API or a version in swagger hub, back up with yaml, and unpublish before deletion using API, my hub, or version controls.

Get a practical overview of Swagger codegen, learn how it generates ready-to-use client and server skeletons in multiple languages, and how to configure codegen options for rapid API scaffolding.

Generate a server stub from Swagger Hub using Codegen options, choose ASP.NET Core, and review the generated zip contents including source code, build.bat, and Readme with API documentation.

Build the generated code with swagger, restoring packages and compiling with dotnet build, then resolve any warnings, run the project, and test APIs at localhost:5000 (http) and port 5001 (https).

Test the swagger generated server at localhost:5000 using postman to perform a get request for courses with basic authentication, and explore extending the server stub.

Install and use the swagger inspector extension to execute get operations, configure basic authentication, and fetch course data from the API server.

Generate the client sdk code using swagger codegen for C# by exporting the client sdk. Open the package in Visual Studio Code to review the api files, models, and readme.

Build the generated client SDK from Swagger Codegen with dotnet build, install required packages, and test API operations like add, delete, and get course.

Explore how Swagger Hub organizes collaboration through organizations, projects, teams, and APIs, enabling seamless sharing and management of domains across teams.

Create a new organization in Swagger Hub to enable collaboration, using the 14-day trial. Learn to access settings, manage members, teams, projects, and Docs branding options.

Create a new project under your organization by naming it and saving, then manage its settings, APIs, domains, and member invites.

Create and manage an organization API in Swagger Hub, choose project and visibility, then create a domain with open API 3.0.0 to share reusable components across APIs.

Collaborate on APIs in Swagger Hub by sharing the API, inviting users or teams, and assigning roles. Note that edits are not real-time, use comments, and enforce custom standardization rules.