前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >java:swagger-codegen生成CSharp(C#) Client

java:swagger-codegen生成CSharp(C#) Client

作者头像
10km
发布2021-12-15 09:24:49
1K0
发布2021-12-15 09:24:49
举报
文章被收录于专栏:10km的专栏

基于Swagger的在线文档,Swagger提供了生成多种语言client端代码的功能。 如果Java Web服务基于Swagger提供了在线文档,基于服务运行时提供的在线文档,就可以生成client端代码,本文以CSharp(C#)为例说明生成CSharp Client的过程

使用 Swagger提供的Client端代码生成工具swagger-codegen生成的CSharp client代码通过hello-world服务的HTTP服务接口(RESTful Web API)与Jav Web服务交互。

swagger-codegen生成的是一个完整的包含Visual Studio编译工程文件的CSharp代码,将生成的CSharp 代码用Visual Studio编译成动态库,就可以为CSharp 项目调用。下介绍swagger-codegen的生成CSharp Client的过程。

运行swagger-codegen 需要JDK 7(及以上)支持.

下载 swagger-codegen

从maven中央仓库下载 swagger-codegen (io.swagger:swagger-codegen-cli:2.4.20)

下载位置:https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.20/swagger-codegen-cli-2.4.20.jar Linux或MacOS下可以用wget下载:

代码语言:javascript
复制
	wget https://repo1.maven.org/maven2/io/swagger/swagger-codegen-cli/2.4.20/swagger-codegen-cli-2.4.20.jar

生成代码

swagger-codegen-cli-2.4.20.jar是一个可以独立运行的Java程序,只需要有JRE支持就可以支行,如下命令行执行swagger-codegen-cli生成CSharp代码:

Windows CMD:

代码语言:javascript
复制
    java -jar swagger-codegen-cli-2.4.20.jar generate ^
    		-i http://facelog.facelib.net:26413/v2/api-docs ^
    		-l csharp ^
    		--api-package facelog --model-package facelog.model ^
    		-o facelog-client-csharp 

client\facelog\csharp 为指定生成代码的输出文件夹

Linux:

代码语言:javascript
复制
java -jar swagger-codegen-cli-2.4.20.jar generate \
		-i http://facelog.facelib.net:26413/v2/api-docs \
		-l csharp \
		--api-package facelog --model-package facelog.model \
		-o facelog-client-csharp

facelog.facelib.net:26413为运行的facelog服务主机名和HTTP端口号,可以直接用于测试。swagger-codegen将从运行的facelog服务的Swagger在线文档中获取服务接口信息,据此生成CSharp Cient代码。 facelog-client-csharp 为指定生成代码的输出文件夹

调用示例

参见生成代码文件夹下的README.md

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2021/12/13 ,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 下载 swagger-codegen
  • 生成代码
  • 调用示例
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档