Skip to content

Add Custom Client example to the docs#435

Merged
harishmohanraj merged 7 commits into
mainfrom
424-write-documentation-on-how-to-create-a-custom-client-and-make-it-work-with-the-fastapi-provider
Oct 21, 2024
Merged

Add Custom Client example to the docs#435
harishmohanraj merged 7 commits into
mainfrom
424-write-documentation-on-how-to-create-a-custom-client-and-make-it-work-with-the-fastapi-provider

Conversation

@harishmohanraj

Copy link
Copy Markdown
Contributor

Fixes #424

Type of change

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

Comment thread docs/docs_src/getting_started/fastapi/custom_fastapi_client.py Outdated
…on-on-how-to-create-a-custom-client-and-make-it-work-with-the-fastapi-provider
@codecov

codecov Bot commented Oct 21, 2024

Copy link
Copy Markdown

Codecov Report

Attention: Patch coverage is 62.50000% with 6 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
...ting_started/fastapi/main_custom_fastapi_client.py 62.50% 6 Missing ⚠️
Files with missing lines Coverage Δ
...ting_started/fastapi/main_custom_fastapi_client.py 62.50% <62.50%> (ø)

... and 4 files with indirect coverage changes

- Client sends tasks/questions
- Server processes request and sends the response
- Server sending workflow message to the client
- Client sending optional message to the server

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Client sending response to the server if required by received message

- Server processes request and sends the response
- Server sending workflow message to the client
- Client sending optional message to the server
- Server processes request and sends the next workflow message

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Server processes sends the next workflow message

- In a real-world scenario, you'd use a separate frontend built with a framework like React or Vue.js.
- The below example uses a **simple HTML with JavaScript**, all in a single string and served directly from the FastAgency FastAPI app for **simplicity**.
- This approach is **not suitable for production** but ideal for demonstrating core concepts.
- In a real-world scenario, you'd use a separate frontend built with a framework like **React or Vue.js**.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

you can also say that most other languages and frameworks could be using this, like go, java,..

…on-on-how-to-create-a-custom-client-and-make-it-work-with-the-fastapi-provider
…on-on-how-to-create-a-custom-client-and-make-it-work-with-the-fastapi-provider
@harishmohanraj harishmohanraj added this pull request to the merge queue Oct 21, 2024
Merged via the queue into main with commit 0b3e46e Oct 21, 2024
@harishmohanraj harishmohanraj deleted the 424-write-documentation-on-how-to-create-a-custom-client-and-make-it-work-with-the-fastapi-provider branch October 21, 2024 12:25
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.

Write documentation on how to create a customHTML/JS client for FastAPI adapter

2 participants