fiber icon indicating copy to clipboard operation
fiber copied to clipboard

docs: add docs for new client

Open efectn opened this issue 9 months ago • 4 comments

Description

This PR adds documentation for new client of Fiber v3.

To-Do List:

  • [x] Request
  • [x] Response
  • [x] Client
    • [x] Perhaps more information about the client. i.e when to use/when not to use
  • [x] Hooks
  • [x] Examples

Changes introduced

  • [x] Documentation Update: Detail the updates made to the documentation and links to the changed files.

Type of change

  • [x] Documentation update (changes to documentation)

Commit formatting

Please use emojis in commit messages for an easy way to identify the purpose or intention of a commit. Check out the emoji cheatsheet here: CONTRIBUTING.md

Summary by CodeRabbit

  • Documentation

    • Updated API documentation navigation order for better usability.
    • Introduced new client documentation detailing enhanced features like Cookiejar, request/response hooks, and improved HTTP client functionalities.
  • Refactor

    • Improved readability and consistency of method names and comments in code related to HTTP client operations.
  • Chores

    • Minor comment correction in the Response struct method definition for clarity.

efectn avatar Apr 29 '24 18:04 efectn

Walkthrough

The recent updates across various documentation files introduce significant enhancements to the Gofiber client library. These include new examples for authentication, TLS, and cookie management, detailed descriptions of request and response structures, and advanced functionalities such as hooks and extensive method additions for better request and response handling.

Changes

File Path Change Summary
docs/client/examples.md Added examples for basic authentication, TLS configuration, and cookie management.
docs/client/hooks.md Introduced request and response hooks with function signatures for customization.
docs/client/request.md Expanded Request structure with numerous methods for handling HTTP requests and data manipulation.
docs/client/response.md Detailed the Response structure including methods for handling responses and data formats.
docs/client/rest.md Enhanced Client struct with new methods for configuration, request/response handling, and marshaling.

🐰✨ In the burrows of code, where the data hops around, A rabbit worked hard, with changes profound. Hooks, requests, and clients galore, In the library's heart, new features we store. Hop along, developers, with joy let's proceed, For in Gofiber's docs, you'll find all you need! 🌟 🐰✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Apr 29 '24 18:04 coderabbitai[bot]

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 82.82%. Comparing base (109ccdd) to head (cfe5e80).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2991      +/-   ##
==========================================
- Coverage   82.85%   82.82%   -0.03%     
==========================================
  Files         115      115              
  Lines        8409     8409              
==========================================
- Hits         6967     6965       -2     
- Misses       1105     1106       +1     
- Partials      337      338       +1     
Flag Coverage Δ
unittests 82.82% <ø> (-0.03%) :arrow_down:

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Apr 29 '24 18:04 codecov[bot]

@efectn image double client as point only confuses we have to rename the first child point

ReneWerner87 avatar May 12 '24 07:05 ReneWerner87

@efectn image double client as point only confuses we have to rename the first child point

image

ReneWerner87 avatar May 12 '24 08:05 ReneWerner87