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는 API 빌드에 대한 선언적 접근 방식을 권장하는 후드 아래에서 Utopia Framework을 사용합니다. 레이블에서 남용 제한, 매개변수 정의에 이르기까지 경로 메타데이터를 코드베이스의 일부로 명시적으로 선언하여 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는 Twig 템플릿을 사용하여 각 API 끝점에 대한 코드 예제를 만드는 무거운 작업을 수행합니다. 위의 API 경로 메타데이터는 다음 Node.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 개선에 관심이 있다면 GitHub에서 contribution guide을 확인하십시오. 성장하는 Appwrite 커뮤니티의 새로운 회원을 항상 환영합니다.

추가 읽기

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

Your Docs Are a Gateway to Your Devtool