Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

📝 Update OpenAPI client generation docs to use@hey-api/openapi-ts#11339

Merged
tiangolo merged 3 commits intofastapi:masterfrom
jordanshatford:feat/update-docs-for-openapi-codegen
Apr 3, 2024
Merged

📝 Update OpenAPI client generation docs to use@hey-api/openapi-ts#11339
tiangolo merged 3 commits intofastapi:masterfrom
jordanshatford:feat/update-docs-for-openapi-codegen

Conversation

@jordanshatford
Copy link
Contributor

@jordanshatfordjordanshatford commentedMar 23, 2024•
edited
Loading

Update openapi typescript client codegen docs.

Seeopenapi-typescript-codegen maintainers commenthere andhere

The@hey-api/openapi-ts repository was originally a fork, but has been detached as we plan to continue maintaining but also add improvements to the original project.

Many bugs in the original project have been fixed already in this package. We are actively tracking reported issues to the repository and will fix as quickly as possible.

Docs related:

  • The command has been renamed fromopenapi toopenapi-ts to avoid clashing.
  • useUnionTypes was removed and is now default behaviour.
  • useOptions is being deprecated and is now default behaviour with warning otherwise.

Disclaimer:
I am one of the people who is going to be maintaining the new package.

mrlubos, nicolas-chaulet, and codespearhead reacted with heart emoji
@tiangolo
Copy link
Member

📝 Docs preview for commit0b5533b at:https://d05fcddf.fastapitiangolo.pages.dev

@tiangolo
Copy link
Member

📝 Docs preview for commit565b877 at:https://f4c44230.fastapitiangolo.pages.dev

@alejsdevalejsdev added the docsDocumentation about how to use FastAPI labelMar 28, 2024
@tiangolo
Copy link
Member

📝 Docs preview for commit69acdcb at:https://819ac387.fastapitiangolo.pages.dev

@jordanshatford
Copy link
ContributorAuthor

@alejsdev is this something that can eventually be merged? If so I will make sure to keep it up to date

@tiangolo
Copy link
Member

📝 Docs preview for commitda79f98 at:https://25bcd7c5.fastapitiangolo.pages.dev

Copy link

@codespearheadcodespearhead left a comment•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

For reference: thenicolas-chaulet/openapi-typescript-codegen repo mentioned by the original maintainer redirects tohey-api/openapi-ts.

@tiangolo
Copy link
Member

Great! Thanks@jordanshatford! 🎉

Looking forward to your improvements in the library! 🚀

I'm already wishing there would be an option to expose objects with the JSON Schema, similar to the previous--exportSchemas, but using pure JSON Schema as is instead of a custom object shape/format. 🤓

alejsdev reacted with laugh emojijordanshatford and mrlubos reacted with heart emoji

@tiangolotiangolo changed the title📝 Update openapi codegen docs📝 Update OpenAPI client generation docs to use@hey-api/openapi-tsApr 3, 2024
@tiangolotiangolo merged commit71321f0 intofastapi:masterApr 3, 2024
@jordanshatford
Copy link
ContributorAuthor

Great! Thanks@jordanshatford! 🎉

Looking forward to your improvements in the library! 🚀

I'm already wishing there would be an option to expose objects with the JSON Schema, similar to the previous--exportSchemas, but using pure JSON Schema as is instead of a custom object shape/format. 🤓

We will look into that and see! That would be a good option to provide

@mrlubos
Copy link
Contributor

mrlubos commentedApr 3, 2024•
edited
Loading

Thank you@tiangolo! Are/were you using the previous library? Are you able to provide more context why you'd want a JSON schema? Feel free to add notes directly to the issuehey-api/openapi-ts#224

tiangolo reacted with rocket emoji

@tiangolo
Copy link
Member

Thanks@mrlubos! I just did. 🤓

@mrlubos
Copy link
Contributor

@tiangolo just updating here as well that JSON Schemas are supported as ofv0.36.0 🎉 Any more feedback is welcome!

hsuanchi pushed a commit to hsuanchi/fastapi that referenced this pull requestMay 26, 2024
@mrlubos
Copy link
Contributor

@tiangolo I keep coming back to the Generate Clients tutorial page. Hey API's package keeps evolving and the tutorial is slowly getting out of sync. I don't have a good solution for this yet, but keep thinking there should be a delineation between the FastAPI -> OpenAPI step (FastAPI's domain) and OpenAPI -> TypeScript step (Hey API's domain). That way it would be easier to maintain. Sometimes I get questions about OpenAPI but it's actually something people need to handle in their FastAPI code. Maybe you're experiencing the same in reverse?

Let me know if you had any thoughts on this!

tl;dr how to handle Generate Clients tutorial getting out of sync

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

1 more reviewer

@codespearheadcodespearheadcodespearhead approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

docsDocumentation about how to use FastAPI

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@jordanshatford@tiangolo@mrlubos@codespearhead@alejsdev

Comments

[8]ページ先頭
©2009-2026 Movatter.jp