|
所在平台: Udemy |
课程主页: https://www.udemy.com/course/openapi-swagger/
课程评论：没有评论
**课程名称：OpenAPI (Swagger) 入门：学习 API 设计方法！从 Swagger 概念到 API 文档编写** **课程概述：** 本课程将带您系统学习 API 设计标准规范 OpenAPI (Swagger) 的基本概念和构成要素。您将学会设置 Swagger Editor 环境，掌握使用 YAML 格式编写 Swagger Specification 的方法，并能完成 API 文档的创建和 Stub 的生成。 **课程特色：** * 全面掌握 OpenAPI (Swagger) 的基本概念和构成要素。 * 实践安装和配置 Swagger Editor。 * 深入学习 YAML 格式的 Swagger Specification 编写技巧。 * 学会创建 API 文档和生成 Stub，并进行 API 测试。 **课程内容（部分）：** 1. **OpenAPI (Swagger) 入门：** 了解 API、RESTful API 的概念，以及 Swagger 的主要组件。 2. **Swagger Editor 的设置：** 配置 Swagger Editor 环境，安装 Swagger Viewer。 3. **Swagger Specification 的编写：** 学习 YAML 基础语法，掌握 `info`、`servers`、`paths`（包括请求参数、请求体、响应）、`tags`、`components`、`security` 等关键部分的编写方法。 4. **Stub 的创建与执行：** 学习如何创建 Stub 并执行，用于 API 测试。 **学习目标：** * 理解 OpenAPI (Swagger) 的基本概念。 * 能够安装和配置 Swagger Editor。 * 掌握使用 YAML 编写 OpenAPI Specification 的方法。 * 能够设计 API 端点，定义请求和响应。 * 能够创建 Stub 来测试 API。 **适合人群：** * 希望学习 RESTful API 设计的开发者。 * 希望利用 OpenAPI (Swagger) 创建 API 文档的人员。 * 希望了解如何使用 YAML 格式编写 API 规范的人员。 **请注意：** 本课程侧重于 OpenAPI (Swagger) 的规范和应用，不会深入讲解 API 的后端实现（如 Java、Node.js 等）。
◯タイトルOpenAPI（Swagger）の基本概念と構成要素からSwagger Editorのセットアップと環境構築、Swagger Specification（YAML形式）の記述方法、そしてAPIドキュメントの作成とスタブの生成までを行います！◯本講座の特徴本講座では、API設計の標準仕様である OpenAPI（Swagger） を学び、APIドキュメントの作成からスタブの生成までを体系的に習得します。以下のポイントを中心に、実践的な内容を扱います。OpenAPI（Swagger）の基本概念と構成要素Swagger Editorのセットアップと環境構築Swagger Specification（YAML形式）の記述方法APIドキュメントの作成とスタブの生成◯本講座の説明OpenAPI（旧Swagger） は、RESTful APIを設計・記述し、視覚的なドキュメントを生成するための業界標準仕様です。本講座では、API開発に不可欠な OpenAPIの仕様 を学びながら、実際に Swagger Editorを活用してAPI設計を行う方法 を実践的に解説します。また、YAML形式でSwagger Specificationを記述し、APIの設計・テスト・ドキュメント生成をスムーズに行うスキルを習得できます。本講座を通じて、以下のスキルを身につけることができます。OpenAPI（Swagger）の基本概念の理解Swagger Editorのインストールと環境構築Swagger Specification（YAML）の記述方法APIエンドポイントの設計とリクエスト・レスポンスの定義スタブの作成と実行によるAPIのテスト◯目次1. OpenAPI（Swagger）入門API・RESTful APIとはSwaggerの主要コンポーネント2. Swagger EditorのセットアップSwagger EditorのセットアップSwagger Viewerのインストール3. Swagger Specificationの書き方YAMLの書き方ルートオブジェクトinfoの書き方serverspathsの書き方pathsの書き方（リクエストパラメーター）pathsの書き方（リクエストボディ）pathsの書き方（レスポンス）tagsの書き方componentsの書き方securityの書き方4. スタブの作成と実行スタブの作成と実行◯注意事項本講座では、 OpenAPI（Swagger）の仕様と活用方法 に重点を置いて解説します。そのため、APIのバックエンド実装（Java・Node.jsなど）については詳細に扱いません。本講座は、以下のような方におすすめです。RESTful APIの設計を学びたい方OpenAPI（Swagger）を活用してAPIのドキュメントを作成したい方YAML形式でAPI仕様を記述する方法を知りたい方この講座を通じて、API設計のスキルを高め、実際の開発現場で即戦力となる技術を習得しましょう！
