Unchase OpenAPI Connected Service 使用教程

Unchase OpenAPI Connected Service 使用教程

Unchase.OpenAPI.Connectedservice:scroll: Visual Studio extension to generate OpenAPI (Swagger) web service reference.项目地址:https://gitcode.com/gh_mirrors/un/Unchase.OpenAPI.Connectedservice

1. 项目的目录结构及介绍

Unchase.OpenAPI.Connectedservice/
├── CHANGELOG.md
├── LICENSE
├── README.md
├── src/
│   ├── Unchase.OpenAPI.ConnectedService/
│   │   ├── ConnectedService.json
│   │   ├── ConnectedService.csproj
│   │   ├── Resources/
│   │   │   ├── icon.png
│   │   │   ├── logo.png
│   │   ├── Services/
│   │   │   ├── OpenApiConnectedService.cs
│   │   ├── Views/
│   │   │   ├── MainView.xaml
│   │   │   ├── MainView.xaml.cs
│   ├── Unchase.OpenAPI.ConnectedService.Tests/
│   │   ├── ConnectedService.Tests.csproj
│   │   ├── Tests/
│   │   │   ├── OpenApiConnectedServiceTests.cs
├── .gitignore
├── .editorconfig
├── .gitattributes

目录结构介绍

• CHANGELOG.md: 记录项目的更新日志。
• LICENSE: 项目的许可证文件。
• README.md: 项目的主文档，包含项目介绍、安装和使用说明。
• src/: 源代码目录。
  • Unchase.OpenAPI.ConnectedService/: 主项目目录。
    • ConnectedService.json: 配置文件。
    • ConnectedService.csproj: 项目文件。
    • Resources/: 资源文件目录，包含图标和logo。
    • Services/: 服务类目录，包含核心服务类。
    • Views/: 视图目录，包含主界面视图。
  • Unchase.OpenAPI.ConnectedService.Tests/: 测试项目目录。
    • ConnectedService.Tests.csproj: 测试项目文件。
    • Tests/: 测试类目录，包含测试用例。
• .gitignore: Git忽略文件配置。
• .editorconfig: 编辑器配置文件。
• .gitattributes: Git属性配置文件。

2. 项目的启动文件介绍

项目的启动文件位于 src/Unchase.OpenAPI.ConnectedService/Views/MainView.xaml 和 MainView.xaml.cs。

MainView.xaml

<Window x:Class="Unchase.OpenAPI.ConnectedService.Views.MainView"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        Title="Unchase OpenAPI Connected Service" Height="450" Width="800">
    <Grid>
        <!-- 界面布局 -->
    </Grid>
</Window>

MainView.xaml.cs

namespace Unchase.OpenAPI.ConnectedService.Views
{
    public partial class MainView : Window
    {
        public MainView()
        {
            InitializeComponent();
        }
    }
}

启动文件介绍

• MainView.xaml: 主界面布局文件，定义了窗口的外观和布局。
• MainView.xaml.cs: 主界面逻辑文件，包含窗口的初始化和事件处理逻辑。

3. 项目的配置文件介绍

项目的配置文件位于 src/Unchase.OpenAPI.ConnectedService/ConnectedService.json。

ConnectedService.json

{
    "ServiceName": "Unchase OpenAPI Connected Service",
    "ServiceDescription": "Connected service for Visual Studio to generate OpenAPI (Swagger) web service reference",
    "ServiceVersion": "1.9.1",
    "ServiceSettings": {
        "OpenApiUrl": "https://petstore.swagger.io/v2/swagger.json",
        "OutputPath": "GeneratedCode",
        "Namespace": "MyNamespace",
        "GenerateClientClasses": true,
        "GenerateDtoTypes": true,
        "UseBaseUrl": true
    }
}

配置文件介绍

• ServiceName: 服务的名称。
• ServiceDescription: 服务的描述。

Unchase.OpenAPI.Connectedservice:scroll: Visual Studio extension to generate OpenAPI (Swagger) web service reference.项目地址:https://gitcode.com/gh_mirrors/un/Unchase.OpenAPI.Connectedservice