Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

.net 9 without comments in scalar UI #3881

Closed
XLJ-CN opened this issue Nov 14, 2024 · 3 comments
Closed

.net 9 without comments in scalar UI #3881

XLJ-CN opened this issue Nov 14, 2024 · 3 comments
Labels
bug Something isn't working

Comments

@XLJ-CN
Copy link

XLJ-CN commented Nov 14, 2024

What happens?

hi,
你好啊,
.net 9 release lastday;
.net9昨天发布了;
Thank you for your excellent work!
感谢你们的付出!
I wrote the code according to documentation,But I have some problems.
我按照文档来编写代码,但是遇到了一些问题
There is no detailed annotation explanation in the web view, such as my method description and the meaning of my fields;
使用Scalar时在web界面中不显示方法注释和我的字段说明;
swagger
image
scalar(no comments )
image

Do I need to configure it in OpenAPI or in Scalar to solve this problem?(in the swagger i can use XML file)
我是需要配置OpenApi呢还是配置Scalar?(使用swagger的时候是配置一个XML文件就可以)
Thank you very much!
非常非常感谢!

What did you expect to happen?

Display my method instructions and field descriptions
显示方法说明和字段说明

OpenAPI Document

No response

@XLJ-CN XLJ-CN added the bug Something isn't working label Nov 14, 2024
@xC0dex
Copy link
Collaborator

xC0dex commented Nov 14, 2024

Hey, which OpenAPI document generator are you using? Did you switch to Microsoft.AspNetCore.OpenApi package? If so, this package currently has no support for reading XML comments. This feature request is reported in dotnet/aspnetcore#39927. However, you could use attributes like [EndpointDescription]. The docs can be found here.

@XLJ-CN
Copy link
Author

XLJ-CN commented Nov 14, 2024

Hey, which OpenAPI document generator are you using? Did you switch to Microsoft.AspNetCore.OpenApi package? If so, this package currently has no support for reading XML comments. This feature request is reported in dotnet/aspnetcore#39927. However, you could use attributes like [EndpointDescription]. The docs can be found here.

thank you very much,your reply help me a lot!
非常感谢,你的回复对我帮助很大!
use such as [EndpointDescription] can work!
使用像 [EndpointDescription] 这样的标签就可以了!
But I also hope can support dotnet/aspnetcore#39927 it is very convenient !
但是我还是期望能够实现这个请求,这样读取xml生成文档的方式是非常方便的!

@xC0dex
Copy link
Collaborator

xC0dex commented Nov 14, 2024

Glad to hear that your question has been answered. I'll close this issue.

@xC0dex xC0dex closed this as completed Nov 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants