# APIFixer
APIFixer is a powerful automation tool built for API developers. It starts an API server using Uvicorn, analyzes its routes, generates detailed documentation using OpenAI, and performs automated tests of API endpoints. Key features include:
1. API Server Startup: Allows you to easily start the server with minimal configuration.
2. API Documentation Generation: Uses OpenAI to generate detailed documentation based on API routes.
3. Automatic testing of API routes: Checks for errors and writes the results to a log file.
4. Support for auto-close server: Ability to automatically close the server after all tasks are completed.
5. This tool simplifies the API development and testing process, minimizes errors, and creates easy-to-use documentation.
Developed by Bohdan Terskow (c) 2024
## Usage Process
### Parameter Setup:
Define parameters when initializing the APIFixer class, such as resource (resource), host (host), port (port), and the OpenAI API key (openai_api_key).
### Start the server and generate documentation:
Call the run method to start the server. This method also starts the route validation process, which automatically generates documentation and performs API testing.
### Testing and Logging:
API route validation and testing occurs in the background and the results are written to a log file.
### Auto-close server:
If auto_close_server=True is set, the server will automatically close after all tasks are completed.
```python
fixer = APIFixer(
resource='main:app',
host='127.0.0.1',
port=8000,
openai_api_key='your_openai_api_key'
)
fixer.run(auto_close_server=True)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/gods-created/APIFixer",
"name": "APIFixer",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python, logs, api, fastapi, docs, ai, openai",
"author": "Bohdan Terskow",
"author_email": "bohdanterskow@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/82/f1/32f1b31aee4c64e0bbc4cb01dd044ea774058365a6cc217c18602bb039a1/APIFixer-1.1.1.tar.gz",
"platform": null,
"description": "# APIFixer\r\n\r\nAPIFixer is a powerful automation tool built for API developers. It starts an API server using Uvicorn, analyzes its routes, generates detailed documentation using OpenAI, and performs automated tests of API endpoints. Key features include:\r\n\r\n1. API Server Startup: Allows you to easily start the server with minimal configuration.\r\n2. API Documentation Generation: Uses OpenAI to generate detailed documentation based on API routes.\r\n3. Automatic testing of API routes: Checks for errors and writes the results to a log file.\r\n4. Support for auto-close server: Ability to automatically close the server after all tasks are completed.\r\n5. This tool simplifies the API development and testing process, minimizes errors, and creates easy-to-use documentation.\r\n\r\nDeveloped by Bohdan Terskow (c) 2024\r\n\r\n## Usage Process\r\n\r\n### Parameter Setup:\r\n\r\nDefine parameters when initializing the APIFixer class, such as resource (resource), host (host), port (port), and the OpenAI API key (openai_api_key).\r\n\r\n### Start the server and generate documentation:\r\n\r\nCall the run method to start the server. This method also starts the route validation process, which automatically generates documentation and performs API testing.\r\n\r\n### Testing and Logging:\r\n\r\nAPI route validation and testing occurs in the background and the results are written to a log file.\r\n\r\n### Auto-close server:\r\n\r\nIf auto_close_server=True is set, the server will automatically close after all tasks are completed.\r\n\r\n```python\r\nfixer = APIFixer(\r\n resource='main:app',\r\n host='127.0.0.1',\r\n port=8000,\r\n openai_api_key='your_openai_api_key'\r\n)\r\n\r\nfixer.run(auto_close_server=True)\r\n```\r\n",
"bugtrack_url": null,
"license": null,
"summary": "APIFixer is a Python class that automatically starts an API server, checks its routes, generates documentation based on the OpenAI API, and tests API endpoints to fix bugs and improve API performance.",
"version": "1.1.1",
"project_urls": {
"Homepage": "https://github.com/gods-created/APIFixer"
},
"split_keywords": [
"python",
" logs",
" api",
" fastapi",
" docs",
" ai",
" openai"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a82c927ada61e9478fa6a66a1fb061372d56ac5928503d5b1705fdd4be20d2ef",
"md5": "ccd53b2dcf165b9faed6a57a76842c2c",
"sha256": "968301e888c970d63494c5e9cbc5175710b9ec09da133de062271af7385de41f"
},
"downloads": -1,
"filename": "APIFixer-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ccd53b2dcf165b9faed6a57a76842c2c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4960,
"upload_time": "2024-08-04T19:22:19",
"upload_time_iso_8601": "2024-08-04T19:22:19.878974Z",
"url": "https://files.pythonhosted.org/packages/a8/2c/927ada61e9478fa6a66a1fb061372d56ac5928503d5b1705fdd4be20d2ef/APIFixer-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "82f132f1b31aee4c64e0bbc4cb01dd044ea774058365a6cc217c18602bb039a1",
"md5": "bd06508e2064022a8d6a55613373f9b5",
"sha256": "2dca1cfa787371bbacc25535380e93df74cf746162f3692e9d001996352a2dbf"
},
"downloads": -1,
"filename": "APIFixer-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "bd06508e2064022a8d6a55613373f9b5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4814,
"upload_time": "2024-08-04T19:22:21",
"upload_time_iso_8601": "2024-08-04T19:22:21.963116Z",
"url": "https://files.pythonhosted.org/packages/82/f1/32f1b31aee4c64e0bbc4cb01dd044ea774058365a6cc217c18602bb039a1/APIFixer-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-04 19:22:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "gods-created",
"github_project": "APIFixer",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "apifixer"
}
JSON
