10000 docs: add information about manual AsyncAPI hosting by YassinNouh21 · Pull Request #2176 · ag2ai/faststream · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

docs: add information about manual AsyncAPI hosting #2176

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

Closed

Conversation

YassinNouh21
Copy link

Description

This PR adds comprehensive documentation about manual AsyncAPI hosting using FastStream's public API functions. It addresses issue #2163 by providing detailed examples and explanations of how to use get_app_schema and get_asyncapi_html functions for custom AsyncAPI documentation hosting.

The changes include:

  • A new section on manual AsyncAPI hosting
  • Examples of using the public API functions
  • Integration examples with ASGI frameworks
  • Proper lifecycle management examples
  • Links to related documentation

Fixes #2163

Type of change

  • Documentation (typos, code examples, or any documentation updates)

Checklist

  • My code adheres to the style guidelines of this project (scripts/lint.sh shows no errors)
  • I have conducted a self-review of my own code
  • I have made the necessary changes to the documentation
  • My changes do not generate any new warnings
  • I have included code examples to illustrate the modifications

@CLAassistant
Copy link
CLAassistant commented Apr 11, 2025

CLA assistant check
All committers have signed the CLA.

Copy link
Collaborator
@Lancetnik Lancetnik left a comment

Choose a reason for hiding this comment

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

@YassinNouh21 thank you for the PR a lot! But, I already assigned @Sehat1137 to this Issue – so he has a priority on PR. If there no any activity from him until 18th April – I'll merge the current PR.

If your want to help with the documentation – you can work on any Issue without assigned contributor.

As an example, you can improve the RPC documentation page – we should add information about how should subscriber looks like to response on messages. Also, we should add information about Reponse class usage to this page. If you would like to help with this, I'll create an Issue and assign you to it

9740
@Lancetnik
Copy link
Collaborator

Closed in prior to #2177

@Lancetnik Lancetnik closed this Apr 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: add information about manual AsyncAPI hosting
3 participants
0