appwriteオープンソースのドキュメントを開放する

AppWriteでは、我々は最高の開発者の経験を作成することに焦点を当てている理由は、我々は学ぶことが容易なツールを構築する理由です.そのために、我々はそれを発表するためにぞっとしていますdocs 現在オープンソースで利用可能ですGitHub !

We're building Appwrite, an open-source Backend-as-a-Service (BaaS), packaged as a set of Docker microservices, to give developers of any background all of the tools necessary to build a modern apps quickly and securely.

コードとしてのドキュメント
appwrite使用するUtopia Framework フードの下では、APIを構築する宣言的なアプローチを奨励します.私たちは明示的にルートのメタデータ-パラメータから定義への虐待の制限を宣言しますAPI specification , でもSDKs そして、複数のプログラミング言語のコード例.
例えば、listCollections メソッドは、endpoint documentation :

App::get('/v1/database/collections')
    ->desc('List Collections')
    ->label('sdk.method', 'listCollections')
    ->label('sdk.description', '/docs/references/database/list-collections.md')
    ->param('search', '', new Text(256), 'Search term to filter your list results. Max length: 256 chars.', true)
    ->param('limit', 25, new Range(0, 100), 'Results limit value. By default will return maximum 25 results. Maximum of 100 results allowed per request.', true)
    ->param('offset', 0, new Range(0, 40000), 'Results offset. The default value is 0. Use this param to manage pagination.', true)

我々SDK Generator 各APIエンドポイントのコード例を作成するTwig テンプレート.上記APIルートメタデータは次のノードを作成します.JSコード:

const sdk = require('node-appwrite');

// Init SDK
let client = new sdk.Client();
let database = new sdk.Database(client);

client
    .setEndpoint('https://[HOSTNAME_OR_IP]/v1') // Your API Endpoint
    .setProject('5df5acd0d48c2') // Your project ID
    .setKey('919c2d18fb5d4...a2ae413da83346ad2') // Your secret API key
;

let promise = database.listCollections();

promise.then(function (response) {
    console.log(response);
}, function (error) {
    console.log(error);
});

一緒によりよい
AppWriteリモートリモート、国際的なチームなので、我々は多様な意見の強さに感謝します.オープンソースのドキュメントでは、私たちのコミュニティは、明確さ、詳細、または簡潔さ(またはスペルミスを持っていない)のリソースを改善するためにその広い専門知識を貸すことができます.開発ツールは、彼らの技術文書と同じくらい強いです、そして、我々は我々のものを最高にするために出発しました.

始める
あなたがappwriteを改善することに興味があるならば、チェックしてくださいcontribution guide Githubについて我々は常に私たちの成長appwriteコミュニティに新しいメンバーを歓迎して満足している.

エキストラリーディング

How We Integrated Our Docs and SDKs As First-Class Citizens of Our Coding Process

Your Docs Are a Gateway to Your Devtool