logo

Readme-Racker

Say Goodbye to Manual README Writing.

← Back

Show Markdown

Download Markdown

Readme

在庫管理小売モジュール

このモジュールは、小売業向けの在庫、販売、仕入れ、サプライヤー、製品タイプ、およびカテゴリの管理機能を提供します。

機能

  • 製品管理: 製品の追加、更新、削除、および取得。
  • カテゴリ管理: 製品カテゴリの追加、更新、削除、および取得。
  • 製品タイプ管理: 製品タイプの追加、更新、削除、および取得。
  • サプライヤー管理: サプライヤーの追加、更新、削除、および取得。
  • 仕入れ管理: サプライヤーからの製品の仕入れ登録。
  • 販売管理: 顧客への製品の販売登録。

使用例

販売の登録(サービス)

@Service
public class ExampleService {

    private final SaleService saleService;

    public ExampleService(SaleService saleService) {
        this.saleService = saleService;
    }

    public void registerNewSale() {
        SaleDetailsRequestDto saleDetailsRequestDto = SaleDetailsRequestDto.builder()
                .productsList(List.of(ProductPatchRequestDto.builder().name("製品名").build()))
                .amount(new BigDecimal("100.00"))
                .discount(new BigDecimal("0.10"))
                .quantity(1L)
                .build();

        SaleResponseDto saleResponseDto = saleService.registerSale(saleDetailsRequestDto);
        System.out.println("販売が登録されました。ID: " + saleResponseDto.getId());
    }
}

販売の登録(REST API)

販売を登録するには、次のJSONペイロードを使用して/sales/registerにPOSTリクエストを送信します。

{
  "productsList": [
    {
      "name": "製品名"
    }
  ],
  "amount": 100.00,
  "discount": 0.10,
  "quantity": 1
}

curlを使用した例:

curl -X POST \
  http://localhost:8080/sales/register \
  -H 'Content-Type: application/json' \
  -d '{
    "productsList": [
      {
        "name": "製品名"
      }
    ],
    "amount": 100.00,
    "discount": 0.10,
    "quantity": 1
  }'

製品の追加(REST API)

製品を追加するには、次のJSONペイロードを使用して/products/addにPOSTリクエストを送信します。

{
  "name": "新しい製品",
  "description": "製品の説明",
  "categoryId": 1,
  "buyPrice": 50.00,
  "salePrice": 100.00,
  "stock": 100,
  "supplierId": 1,
  "productTypeId": 1
}

curlを使用した例:

curl -X POST \
  http://localhost:8080/products/add \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "新しい製品",
  "description": "製品の説明",
  "categoryId": 1,
  "buyPrice": 50.00,
  "salePrice": 100.00,
  "stock": 100,
  "supplierId": 1,
  "productTypeId": 1
}'

構成の詳細

CORS構成

このモジュールには、Cross-Origin Resource Sharing(CORS)を構成するためのCorsConfigクラスが含まれています。

@Configuration
public class CorsConfig implements WebMvcConfigurer {

    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**")
                .allowedOrigins("http://localhost:5173")
                .allowedMethods("*")
                .allowedHeaders("*")
                .allowCredentials(true);
    }
}

この構成により、http://localhost:5173からのリクエストが許可されます。

依存関係

このモジュールを使用するには、pom.xmlに次の依存関係が必要です。

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>com.h2database</groupId>
            <artifactId>h2</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
        </dependency>

🌍 このREADMEは複数の言語で利用可能です: 🔗 readme.maxpfeffer.de