Strapi v4 - 코어 컨트롤러 확장 및 사용자 지정 경로 생성

내용물

Extend your controller in strapi v4

Get Started

Customizing the api

Conclusion

strapi v4에서 컨트롤러 확장

여러분, 안녕하세요! strapi v4에서 컨트롤러와 경로를 확장하는 방법을 보여 드리겠습니다.

시작하다

먼저 프로젝트를 생성해 보겠습니다. api를 커스터마이징 하고 싶다면 스트래피 환경을 설정하는 방법을 알고 계실 것 같아서 이 부분은 생략하겠습니다.

// npm
npx create-strapi-app@latest my-project --quickstart

// yarn
yarn create strapi-app my-project --quickstart

초기 설정 후 굉장합니다. Hello 라는 컬렉션 유형을 빠르게 만들 수 있습니다. 원하는 이름을 지정할 수 있습니다.



이제 title라는 텍스트 필드를 추가해 보겠습니다.





완료를 클릭하고 컬렉션 유형을 저장한 다음 strapi 앱이 다시 시작될 때까지 기다립니다.

이제 다음 컬렉션 유형이 있어야 합니다.

API 사용자 지정

좋아, 일하러 가자! 농담입니다. 정말 간단합니다. 폴더 구조를 따르십시오:

my-project > src > api > hello

여기에 4개의 폴더가 있습니다.

[콘텐츠 유형, 컨트롤러, 경로, 서비스]
컨트롤러 및 경로 폴더 내에서 자바 스크립트 파일을 엽니다. 둘 다 API와 이름이 같아야 합니다. 나의 경우Hello.js

컨트롤러 > hello.js 내부에서 코드를 다음으로 바꿉니다.

// src/api/hello/controllers/hello.js

"use strict";

const { createCoreController } = require("@strapi/strapi").factories;

module.exports = createCoreController("api::hello.hello", ({ strapi }) => ({
  async findAll(ctx) {
    const entries = await strapi.db.query("api::hello.hello").findMany();

    ctx.body = entries;
  },
}));

여기서 우리는 findAll이라는 추가 기능을 허용하도록 코어 컨트롤러를 확장하고 있습니다. 물론 핵심 컨트롤러에는 이미 find라는 메서드가 있습니다. 이것은 단순함을 위한 것입니다.

이제 route 폴더로 이동하여 custom-hello.js라는 새 파일을 생성해 보겠습니다.

내부에서 우리는 경로(메소드, 경로 및 핸들러)를 정의할 것입니다.

// src/api/hello/routes/custom-hello.js

module.exports = {
  routes: [
    {
      method: "GET",
      path: "/all-hellos",
      handler: "hello.findAll",
    },
  ],
};

그리고 그게 다야! 이제 strapi 앱을 시작하면 설정 > 역할 > 공개 > 안녕하세요*로 이동하면 새 경로가 표시됩니다!



findAll을 확인한 다음 변경 사항을 저장하십시오. hellos 컬렉션 내에 항목을 만들고 http://localhost:1337/api/all-hellos로 이동하여 컬렉션을 확인하세요! 🎉



멋진! 아주 쉽죠?

결론

API를 사용자 정의하는 것은 번거롭고 어떤 경우에는 불필요하게 보일 수 있습니다. 그러나 모든 사람이 한 번에 핵심 API로는 불가능한 문제에 봉착할 것이라고 생각합니다.

예를 들어, 너무 많은 매개변수를 전달하지 않고 id로 제품의 재고를 구체적으로 업데이트합니다.

// Addition to controlers/apiname.js

async updateStock(ctx) {
  const { id } = ctx.params;
  const { stock } = ctx.request.query;

  const entries = await strapi.db.query("api::product.product").update({
    where: { id },
    data: {
      stock,
    },
  });

  ctx.body = entries;
},

그리고 노선에 대해

// Addition to the custom routes file

{
  method: "PUT",
  path: "/update-stock/:id",
  handler: "product.updateStock",
},

Final PUT route http://localhost:1337/api/update-stock/2?stock=5

이 예에서는 제품 컬렉션에 있는 제품의 stock 필드를 업데이트합니다. 때로는 특정 작업에 대한 추가 제어가 필요하며 핵심 컨트롤러/경로를 확장하면 도움이 됩니다.

읽어주셔서 감사하고 해피코딩 🥷‎‍💻