samchon
990
2021-09-24 23:31:00 작성 2021-09-25 00:52:10 수정됨
2
613

[오픈소스] Nestia, automatic SDK generator for NestJS


https://github.com/samchon/nestia 


앞으로는 Swagger 주석 작성하지 마시고, SDK 전달해주세요. 


Nestia 는 NestJS 로 작성한 백엔드 소스 코드를 컴파일 수준에사 분석하여, 클라이언트 개발자가 사용할 수 있는 SDK 라이브러리를 자동으로 만들어줍니다. 때문에 Nestia 를 사용하면, 이전처럼 API 문서를 만들기 위하여 swagger 주석을 작성하는 등의, 불필요한 작업을 일절 할 필요가 없어집니다. 


이는 클라이언트 개발자도 동일하여, 이전처럼 swagger 문서를 해독하여 API 연동 인터페이스를 직접 만드는 일 따위의 수고스러움을 더 이상 감내하지 않아도 됩니다. 단지 nestia 가 만들어 준 sdk 를 import 하고, async await 심벌을 통하여 sdk 가 제공해주는 api 함수들을 호출하기만 하면 될 뿐입니다.



import api from "@samchon/bbs-api";
import { IBbsArticle } from "@samchon/bbs-api/lib/structures/bbs/IBbsArticle";
import { IPage } from "@samchon/bbs-api/lib/structures/common/IPage";

export async function test_article_read(connection: api.IConnection): Promise<void>
{
    // LIST UP ARTICLE SUMMARIES
    const index: IPage<IBbsArticle.ISummary> = await api.functional.bbs.articles.index
    (
        connection,
        "free",
        { limit: 100, page: 1 }
    );

    // READ AN ARTICLE DETAILY
    const article: IBbsArticle = await api.functional.bbs.articles.at
    (
        connection,
        "free",
        index.data[0].id
    );
    console.log(article.title, aritlce.body, article.files);
}


0
  • 댓글 2

  • shirohoo
    1k
    2021-09-25 00:42:34

    외람되지만 링크가 잘못됐습니다.


    https://github.com/samchon/nestia%C2%A0 로 리다이렉트되서 404가 뜨는데

    https://github.com/samchon/nestia로 가면 정상적으로 뜨네요. 👍

  • analisteicyeye
    151
    2021-09-25 01:37:26

    좋은 라이브러리 감사합니다!

  • 로그인을 하시면 댓글을 등록할 수 있습니다.