docs: ✏️ added srcibe for API docs

[mgmgpyaesonewin]

Summary by CodeRabbit

• Documentation

  • Introduced comprehensive API documentation, including authentication details, endpoint descriptions, and usage examples.
  • Added detailed guides and code examples for API usage in various programming languages.
  • Provided styling for both web and print formats of the documentation.

• New Features

  • Enhanced API with new endpoints for user management, keyword retrieval, and spider operations.
  • Implemented a web interface for trying out API endpoints directly from the documentation.

• Bug Fixes

  • Updated validation rules to allow nullable values in specific API requests.

• Refactor

  • Improved controller methods with detailed documentation and refined logic for better performance and usability.

[coderabbitai[bot]]

Walkthrough

The recent update introduces a comprehensive overhaul of the Web Crawler API documentation and its supporting infrastructure within a Laravel application. It includes new guides for authentication, detailed endpoint descriptions, enhanced controller methods, styling for printed and web documentation, and interactive JavaScript features for API testing. This cohesive enhancement aims to improve both developer experience and the application's usability.

Changes

Files	Summary
application-api/.scribe/.filehashes, application-api/.scribe/auth.md, application-api/.scribe/intro.md, application-api/config/scribe.php	Introduced and updated files to enhance API documentation generation and introduce authentication guidelines.
application-api/.scribe/endpoints.cache/00.yaml, application-api/.scribe/endpoints/00.yaml, application-api/.scribe/endpoints/custom.0.yaml	Defined new API endpoints and custom endpoint configurations for improved user and spider management.
application-api/app/Http/Controllers/AppController.php, application-api/app/Http/Requests/StoreSpiderCallbackRequest.php	Updated controller methods and request validation for enhanced functionality and data handling.
application-api/public/docs/css/theme-default.print.css, application-api/public/docs/css/theme-default.style.css, application-api/public/docs/index.html, application-api/public/docs/js/theme-default-4.33.0.js, application-api/public/docs/js/tryitout-4.33.0.js	Added styling and JavaScript functionality for a better documentation interface and interactive API testing.

🐰✨
In the land of code and wire,
Changes bloom like spring's first fire.
Docs and endpoints, freshly sown,
In digital gardens, fully grown.
Through the web, the spiders crawl,
With new paths for one and all.
🌼📚🕸️

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

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

---

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 .` - `Generate unit-tests 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 tests 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 tests.` - `@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. - The JSON schema for the configuration file is available [here](https://coderabbit.ai/integrations/coderabbit-overrides.v2.json). - 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/coderabbit-overrides.v2.json` ### CodeRabbit Discord Community Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback.