开发工具代码生成API设计【免费下载链接】swagger-codegenswagger-codegen contains a template-driven engine to generate documentation, API clients and server stubs in different languages by parsing your OpenAPI / Swagger definition.项目地址https://gitcode.com/gh_mirrors/sw/swagger-codegen点击查看免费下载本文以 swagger-codegen 仓库中 okhttp4-gson-parcelableModel 示例客户端为蓝本系统讲解由 Swagger Codegen 自动生成的UserApi类它对应 Petstore 规范中/user相关的 8 个 REST 端点覆盖用户创建、批量创建、查询、登录、登出与更新。读完本文你将掌握该生成客户端的 API 方法签名、参数/返回值语义、异常处理、同步与异步调用方式并能结合生成源码理解其底层调用链与测试组织方式。1. UserApi 概览端点与 HTTP 映射UserApi是 swagger-codegen 从 petstore.jsonSwagger 2.0 规范basePath为/v2自动生成的 API 类所有 URI 均相对于http://petstore.swagger.io:80/v2。生成源码位于 UserApi.java其 API 文档即 UserApi.md。该客户端围绕用户域暴露以下方法方法HTTP 请求描述createUserPOST/user创建用户createUsersWithArrayInputPOST/user/createWithArray使用数组批量创建用户createUsersWithListInputPOST/user/createWithList使用列表批量创建用户deleteUserDELETE/user/{username}删除用户getUserByNameGET/user/{username}按用户名查询用户loginUserGET/user/login用户登录logoutUserGET/user/logout用户登出updateUserPUT/user/{username}更新用户从生成代码可以推断UserApi内部持有一个ApiClient实例ApiClient.java默认构造器使用Configuration.getDefaultApiClient()也支持传入自定义ApiClient并提供getApiClient()/setApiClient()访问器——这在多线程环境下尤其重要官方 README 建议每个线程独立创建ApiClient实例以避免潜在问题。2. 环境准备构建与引入生成的客户端在调用UserApi之前需要先把生成产物编译为 JAR 并引入工程。构建要求 Java 1.7 与 Maven/Gradle见该样例的 README.md 与 pom.xml。安装到本地 Maven 仓库mvn clean install发布到远程 Maven 仓库需预先配置仓库 settingsmvn clean deployMaven 依赖方式dependency groupIdio.swagger/groupId artifactIdswagger-petstore-okhttp4-gson/artifactId version1.0.0/version scopecompile/scope /dependencyGradle 依赖方式compile io.swagger:swagger-petstore-okhttp4-gson:1.0.0也可以先执行mvn clean package再手动安装target/swagger-petstore-okhttp4-gson-1.0.0.jar与target/lib/*.jar。从 pom.xml 可以看到该客户端的技术栈OkHttp 4.10.0HTTP 层、Gson 2.10.1序列化、gson-fire 1.8.5、threetenbp 1.6.5日期时间、JUnit 4.13.2测试。特别地artifactId 后缀parcelableModel意味着模型类实现了 AndroidParcelablepom 中以provided作用域引入com.google.android:android:4.1.1.4gradle.properties 中注释掉了#target android一行说明该示例默认按 JVM 项目构建取消注释即可切到 Android 构建模式。3. 端点逐个详解以下 8 个端点均完整继承自 UserApi.md并补充了源码层面的行为说明。所有端点当前均标注No authorization required生成代码中localVarAuthNames为空数组请求Accept头均为application/xml, application/jsonContent-Type均未定义。3.1 createUser创建用户方法签名createUser(User body)HTTPPOST /user描述创建用户仅限已登录用户操作注释说明为 This can only be done by the logged in user参数body类型 User必填含义为 Created user object返回类型null空响应体// Import classes: //import io.swagger.client.ApiException; //import io.swagger.client.api.UserApi; UserApi apiInstance new UserApi(); User body new User(); // User | Created user object try { apiInstance.createUser(body); } catch (ApiException e) { System.err.println(Exception when calling UserApi#createUser); e.printStackTrace(); }从生成源码看createUser内部先走createUserValidateBeforeCall校验必填参数若body null会抛出ApiException(Missing the required parameter body when calling createUser(Async))随后构建okhttp3.Call并交由apiClient.execute(call)执行对应还生成了createUserAsync(body, callback)异步版本以及带进度监听的createUserCall(...)底层构建方法。3.2 createUsersWithArrayInput数组批量创建用户方法签名createUsersWithArrayInput(ListUser body)HTTPPOST /user/createWithArray描述使用给定输入数组创建用户列表参数body类型ListUser必填含义为 List of user object返回类型null空响应体// Import classes: //import io.swagger.client.ApiException; //import io.swagger.client.api.UserApi; UserApi apiInstance new UserApi(); ListUser body Arrays.asList(new User()); // ListUser | List of user object try { apiInstance.createUsersWithArrayInput(body); } catch (ApiException e) { System.err.println(Exception when calling UserApi#createUsersWithArrayInput); e.printStackTrace(); }3.3 createUsersWithListInput列表批量创建用户方法签名createUsersWithListInput(ListUser body)HTTPPOST /user/createWithList描述使用给定输入列表创建用户列表参数body类型ListUser必填含义为 List of user object返回类型null空响应体// Import classes: //import io.swagger.client.ApiException; //import io.swagger.client.api.UserApi; UserApi apiInstance new UserApi(); ListUser body Arrays.asList(new User()); // ListUser | List of user object try { apiInstance.createUsersWithListInput(body); } catch (ApiException e) { System.err.println(Exception when calling UserApi#createUsersWithListInput); e.printStackTrace(); }createUsersWithArrayInput与createUsersWithListInput的区别仅在于请求路径/user/createWithArray与/user/createWithList请求体序列化、校验与返回处理逻辑完全一致。3.4 deleteUser删除用户方法签名deleteUser(String username)HTTPDELETE /user/{username}描述删除用户仅限已登录用户操作参数username类型String必填含义为 The name that needs to be deleted返回类型null空响应体// Import classes: //import io.swagger.client.ApiException; //import io.swagger.client.api.UserApi; UserApi apiInstance new UserApi(); String username username_example; // String | The name that needs to be deleted try { apiInstance.deleteUser(username); } catch (ApiException e) { System.err.println(Exception when calling UserApi#deleteUser); e.printStackTrace(); }这是第一个含路径参数{username}的端点。从源码可看到路径占位符替换的实现细节/user/{username}.replaceAll(\\{ username \\}, apiClient.escapeString(username.toString()))即由ApiClient.escapeString对用户名做 URL 转义后再拼入路径避免特殊字符破坏路径结构。3.5 getUserByName按用户名查询用户方法签名User getUserByName(String username)HTTPGET /user/{username}描述按用户名查询用户参数username类型String必填含义为 The name that needs to be fetched. Use user1 for testing.即测试时可使用user1返回类型User// Import classes: //import io.swagger.client.ApiException; //import io.swagger.client.api.UserApi; UserApi apiInstance new UserApi(); String username username_example; // String | The name that needs to be fetched. Use user1 for testing. try { User result apiInstance.getUserByName(username); System.out.println(result); } catch (ApiException e) { System.err.println(Exception when calling UserApi#getUserByName); e.printStackTrace(); }这是本组端点中第一个有实际返回值的查询方法。源码中getUserByName通过getUserByNameWithHttpInfo获取ApiResponseUser再取resp.getData()反序列化类型由 Gson 的TypeTokenUser(){}描述最终由apiClient.execute(call, localVarReturnType)完成。3.6 loginUser用户登录方法签名String loginUser(String username, String password)HTTPGET /user/login描述将用户登录进系统参数usernameString必填The user name for loginpasswordString必填The password for login in clear text注意文档明确为明文密码返回类型String通常为服务端返回的会话令牌/提示字符串// Import classes: //import io.swagger.client.ApiException; //import io.swagger.client.api.UserApi; UserApi apiInstance new UserApi(); String username username_example; // String | The user name for login String password password_example; // String | The password for login in clear text try { String result apiInstance.loginUser(username, password); System.out.println(result); } catch (ApiException e) { System.err.println(Exception when calling UserApi#loginUser); e.printStackTrace(); }loginUser是唯一一个把参数放进query string的端点源码loginUserCall中通过apiClient.parameterToPair(username, username)、parameterToPair(password, password)构造查询参数校验逻辑同时检查username与password两个必填项。3.7 logoutUser用户登出方法签名logoutUser()HTTPGET /user/logout描述登出当前已登录用户会话参数无返回类型null空响应体// Import classes: //import io.swagger.client.ApiException; //import io.swagger.client.api.UserApi; UserApi apiInstance new UserApi(); try { apiInstance.logoutUser(); } catch (ApiException e) { System.err.println(Exception when calling UserApi#logoutUser); e.printStackTrace(); }源码中logoutUserValidateBeforeCall不包含任何必填参数校验直接构建/user/logout的 GET 请求并执行。3.8 updateUser更新用户方法签名updateUser(String username, User body)HTTPPUT /user/{username}描述更新用户仅限已登录用户操作参数usernameString必填name that need to be deleted沿用规范中的原始描述body类型 User必填Updated user object返回类型null空响应体// Import classes: //import io.swagger.client.ApiException; //import io.swagger.client.api.UserApi; UserApi apiInstance new UserApi(); String username username_example; // String | name that need to be deleted User body new User(); // User | Updated user object try { apiInstance.updateUser(username, body); } catch (ApiException e) { System.err.println(Exception when calling UserApi#updateUser); e.printStackTrace(); }该方法是路径参数{username}与请求体body组合的典型代表校验阶段对两个必填参数分别判空。4. 源码级深入UserApi 的统一调用链从 UserApi.java 的完整源码可以归纳出 swagger-codegen 为每个端点生成的三层结构这是理解所有生成 API 类的钥匙xxxCall(...)层负责组装请求——设置localVarPostBody、拼接路径并替换{pathParam}、收集 query/form 参数、通过apiClient.selectHeaderAccept与selectHeaderContentType决定Accept/Content-Type头、声明localVarAuthNames最终调用apiClient.buildCall(path, method, ...)返回okhttp3.Call。若传入进度监听器还会向apiClient.getHttpClient().networkInterceptors()注册拦截器用ProgressResponseBody/ProgressRequestBody包装收发体以回调上传/下载进度。xxxValidateBeforeCall(...)层对必填参数逐个判空缺失即抛ApiException(Missing the required parameter ... when calling xxx(Async))然后转发到xxxCall。公开方法层同步方法如createUser、getUserByName委托xxxWithHttpInfo(...)后者执行apiClient.execute(call[, returnType])有返回值的通过TypeToken描述泛型类型并反序列化同时每个端点都有对应的xxxAsync(..., ApiCallbackT callback)异步版本内部通过apiClient.executeAsync(call, returnType, callback)执行并返回okhttp3.Call供取消等操作使用。这种同步 WithHttpInfo Async三方法对称设计意味着调用方可以根据场景自由选择业务代码直接用同步方法需要拿到完整 HTTP 状态码/响应头时用WithHttpInfo变体返回ApiResponseTUI/事件驱动场景用 Async 回调版本。5. 测试组织UserApiTest 验证swagger-codegen 同时为UserApi生成了 JUnit 测试骨架 UserApiTest.java。该类被Ignore注解标记默认跳过需手动接入 Mock 服务端或真实 Petstore 服务后启用内部维护一个private final UserApi api new UserApi();为每个端点生成一个Test方法createUserTest()、createUsersWithArrayInputTest()、createUsersWithListInputTest()deleteUserTest()、getUserByNameTest()断言响应为UserloginUserTest()断言响应为String、logoutUserTest()updateUserTest()每个测试方法先构造参数当前为null占位再调用对应 API 方法并预留// TODO: test validations注释——开发者只需填充真实参数与断言即可完成针对该客户端的集成测试。6. 关联模型Parcelable 化的 UserUserApi的核心数据载体是 User.java对应模型文档 User.md。其字段与文档一致字段类型描述备注idLong用户 IDoptionalusernameString用户名optionalfirstNameString名optionallastNameString姓optionalemailString邮箱optionalpasswordString密码optionalphoneString电话optionaluserStatusInteger用户状态optional由于该样例启用parcelableModel特性User实现了android.os.Parcelable字段均带 GsonSerializedName注解以保持 JSON 键名映射并提供writeToParcel、Parcel构造器与静态CREATOR工厂同时重写了equals/hashCode/toString。这意味着生成的模型既能在 JVM 环境配合 Gson 完成 JSON 序列化也能在 Android 环境下跨 Intent/Bundle 传递。7. 常见调用模式小结综合文档与源码使用UserApi的推荐流程是通过mvn clean install构建生成客户端或以 Maven/Gradle 依赖方式引入实例化UserApi默认使用全局Configuration中的ApiClient多线程环境建议每个线程独立ApiClient按端点签名构造参数请求体用User/ListUser路径参数传String username登录参数传username password同步调用放在try/catch (ApiException)中捕获并处理异常需要完整响应信息用xxxWithHttpInfo需要非阻塞用xxxAsync(callback)有返回值的端点getUserByName返回User、loginUser返回String直接使用返回值无返回值的端点创建、删除、更新、登出以不抛异常视为调用成功需要联网验证时移除测试类上的Ignore并填充真实参数后运行 JUnit 测试。如需查阅同工程其他 API 类的生成效果可对比 PetApi.md、StoreApi.md 及对应源码其方法组织与UserApi完全一致。赞分享开发工具代码生成API设计【免费下载链接】swagger-codegenswagger-codegen contains a template-driven engine to generate documentation, API clients and server stubs in different languages by parsing your OpenAPI / Swagger definition.项目地址https://gitcode.com/gh_mirrors/sw/swagger-codegen点击查看免费下载相关推荐Swagger Codegen 生成的 Java 客户端 UserApi 使用指南基于 okhttp-gson-parcelableModel 示例的用户管理 API 实战Swagger Codegen 生成的 Java 客户端 UserApi 使用指南基于 okhttp gson parcelableModel 示例的用户管理开发工具代码生成API设计Swagger Petstore Bash 客户端 UserApi 使用指南基于 swagger-codegen 生成的用户管理接口实战Swagger Petstore Bash 客户端 UserApi 使用指南基于 swagger codegen 生成的用户管理接口实战 本文聚焦 swagg开发工具代码生成API设计swagger-codegen 生成 Java okhttp-gson-parcelableModel 客户端的 FakeApi 接口调用指南swagger codegen 生成 Java okhttp gson parcelableModel 客户端的 FakeApi 接口调用指南 本文以 swag开发工具代码生成API设计上一篇gh_mirrors/sh1/sh的代码生成框架从AST到多语言输出下一篇free-stockdb MCP服务器配置指南三步接入AI工具零依赖直查行情创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考