{"id":13534166,"url":"https://github.com/qappwrite/qappwrite","last_synced_at":"2025-04-01T22:31:15.798Z","repository":{"id":217043214,"uuid":"635027995","full_name":"qappwrite/qappwrite","owner":"qappwrite","description":null,"archived":false,"fork":false,"pushed_at":"2023-05-08T19:51:21.000Z","size":166,"stargazers_count":2,"open_issues_count":0,"forks_count":3,"subscribers_count":0,"default_branch":"master","last_synced_at":"2024-11-02T21:31:59.387Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/qappwrite.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-01T20:01:07.000Z","updated_at":"2024-06-29T09:40:04.000Z","dependencies_parsed_at":null,"dependency_job_id":"c81aadc1-a282-437e-af1c-2b404792f906","html_url":"https://github.com/qappwrite/qappwrite","commit_stats":null,"previous_names":["qappwrite/qappwrite"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qappwrite%2Fqappwrite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qappwrite%2Fqappwrite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qappwrite%2Fqappwrite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qappwrite%2Fqappwrite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qappwrite","download_url":"https://codeload.github.com/qappwrite/qappwrite/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246720511,"owners_count":20822913,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T07:01:27.239Z","updated_at":"2025-04-01T22:31:15.791Z","avatar_url":"https://github.com/qappwrite.png","language":"C++","readme":"# QAppWrite - Qt Framework client API\n\n# \n\nAppwrite\n\n- API version: 1.3.0\n\nAppwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)\n\n  For more information, please visit [https://appwrite.io/support](https://appwrite.io/support)\n\n*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*\n\n\n## Requirements\n\nBuilding the API client library requires:\n\n1. CMake 3.2+\n2. Qt\n3. C++ Compiler\n\n## Getting Started\n\nexample.h:\n```c++\n\n#include \u003ciostream\u003e\n#include \"../client/AWAccountApi.h\"\n\nusing namespace test_namespace;\n\nclass Example : public QObject {\n    Q_OBJECT\n    AWAccountCreateRequest create();\npublic slots:\n   void exampleFunction1();\n};\n\n```\n\nexample.cpp:\n```c++\n\n#include \"../client/AWAccountApi.h\"\n#include \"example.h\"\n#include \u003cQTimer\u003e\n#include \u003cQEventLoop\u003e\n\nAWAccountCreateRequest Example::create(){\n    AWAccountCreateRequest obj;\n return obj;\n}\n\nvoid Example::exampleFunction1(){\n     AWAccountApi apiInstance;\n     \n      // Configure API key authorization: Project\n      apiInstance.setApiKey(\"YOUR API KEY NAME\",\"YOUR API KEY\");\n\n      QEventLoop loop;\n      connect(\u0026apiInstance, \u0026AWAccountApi::accountCreateSignal, [\u0026]() {\n          loop.quit();\n      });\n      connect(\u0026apiInstance, \u0026AWAccountApi::accountCreateSignalE, [\u0026](QNetworkReply::NetworkError, QString error_str) {\n          qDebug() \u003c\u003c \"Error happened while issuing request : \" \u003c\u003c error_str;\n          loop.quit();\n      });\n\n      AWAccountCreateRequest aw_account_create_request = create(); // AWAccountCreateRequest | \n      apiInstance.accountCreate(aw_account_create_request);\n      QTimer::singleShot(5000, \u0026loop, \u0026QEventLoop::quit);\n      loop.exec();\n  }\n\n```\n\n## Documentation for Servers\n\nParameterized Servers are supported. Define a server in the API for each endpoint with arbitrary numbers of variables:\n\n```yaml\nservers:\n- url: http://{server}:{port}/{basePath}\n  description: Description of the Server\n  variables:\n    server:\n        enum:\n          - 'appwrite'\n          - 'qa-appwrite'\n          - 'dev-appwrite'\n        default: 'appwrite'\n    port:\n      enum:\n        - '3000'\n        - '1000'\n      default: '3000'\n    basePath:\n      default: v1\n```\nTo change the default variable, use this function in each Api:\n```c++\nint setDefaultServerValue(int serverIndex,const QString \u0026operation, const QString \u0026variable,const QString \u0026val);\n```\nThe parameter \"serverIndex\" will choose a server from the server list for each endpoint. There is always at least one server with index 0. The Parameter \"operation\" should be the desired endpoint operationid.\nVariable is the name of the variable you wish to change and the value is the new default Value.\nThe function will return -1 when the variable does not exists, -2 if value is not defined in the variable enum and -3 if the operation is not found.\n\nIf your endpoint has multiple server objects in the servers array, you can set the server that will be used with this function:\n```c++\nvoid setServerIndex(const QString \u0026operation, int serverIndex);\n```\nParameter \"operation\" should be your operationid. \"serverIndex\" is the index you want to set as your default server. The function will check if there is a server with your index.\nHere is an example of multiple servers in the servers array. The first server will have index 0 and the second will have index 1.\n```yaml\nservers:\n- url: http://{server}:8080/\n  description: Description of the Server\n  variables:\n    server:\n        enum:\n          - 'appwrite'\n          - 'qa-appwrite'\n          - 'dev-appwrite'\n        default: 'appwrite'\n- url: https://localhost:8080/v1\n```\n\n## Documentation for Authorization\n\nAuthentication schemes defined for the API:\n### Project\n\n\n- **Type**: API key\n- **API key parameter name**: X-Appwrite-Project\n- **Location**: HTTP header\n\n### JWT\n\n\n- **Type**: API key\n- **API key parameter name**: X-Appwrite-JWT\n- **Location**: HTTP header\n\n### Locale\n\n\n- **Type**: API key\n- **API key parameter name**: X-Appwrite-Locale\n- **Location**: HTTP header\n\n\n## Authors\n\n- [Grzegorz Kusmierz](https://github.com/gkusmierz)\n\n## License\n\nBSD-3-Clause for more information visit [BSD-3-Clause](https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE)\n","funding_links":[],"categories":["SDK"],"sub_categories":["Community-Built SDKs"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqappwrite%2Fqappwrite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqappwrite%2Fqappwrite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqappwrite%2Fqappwrite/lists"}