Java Micronaut codegen: how to incorporate OpenAPI v3.x relative URLs for endpoint path generation?

未关闭
#1,061 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
4/5
预计耗时
3-5 天
新手友好度
35/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
停滞
技术栈
java, openapi
领域
api, backend

调研方向

首先阅读所引用的 MicronautCodegen.java 实现和 Java mustache templates,以追踪端点路径是如何组装的。使用包含 servers.url 或 basePath 的示例 OpenAPI 规范作为复现用例,然后验证生成的端点在 /users 之前包含 /v1。

由索引模型根据 Issue 内容生成。

描述

Consider an OpenAPI yaml spec file with this definition:

openapi: "3.0.2"
info:
  title: Some title
  description: Some description
  version: 0.0.1
  contact:
    name: Some name
    url: http://www.example.com
    email: [email protected]
servers:
  - url: /v1/
paths:
  /users:
    get:
      operationId: getUsers

I've also tried setting basePath instead:

openapi: "3.0.2"
info:
  title: Some title
  description: Some description
  version: 0.0.1
  contact:
    name: Some name
    url: http://www.example.com
    email: [email protected]
servers:
  - url: http://localhost:8080
basePath: /v1
paths:
  /users:
    get:
      operationId: getUsers

I would have expected that the endpoint path generated is /v1/users, but instead it's just /users.

Is there a way to incorporate this path into my endpoints? Either by subclassing MicronautCodegen, or maybe by editing my mustache templates?

主要语言
Mustache
星标
299
派生
439
PR 合并指标
30 天内没有已合并 PR

环境准备

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

swagger-api/swagger-codegen-generators 的其他 Issue

查看 swagger-api/swagger-codegen-generators 的全部 Issue

相似的 Issue

更多 Backend & API Design Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。