https://github.com/casl0/tech-books-explorer-back

https://github.com/casl0/tech-books-explorer-back

Last synced: over 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/casl0/tech-books-explorer-back
• Owner: CASL0
• License: mit
• Created: 2024-05-24T10:56:42.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2025-02-17T23:03:40.000Z (over 1 year ago)
• Last Synced: 2025-02-18T00:20:08.487Z (over 1 year ago)
• Language: Java
• Size: 143 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build](https://github.com/CASL0/tech-books-explorer-back/actions/workflows/build.yml/badge.svg)](https://github.com/CASL0/tech-books-explorer-back/actions/workflows/build.yml)

[![License](https://img.shields.io/badge/license-MIT-blue)](https://opensource.org/license/mit)

# tech-books-explorer-back

技術書をブラウジングための API サーバーです。

## Getting started

技術書をキーワード検索します。

```sh

curl -X 'GET' \

  'https://localhost:8091/api/v1/books?q=java' \

  -H 'accept: application/json'

```

## Document

- [javadoc](https://casl0.github.io/tech-books-explorer-back/)

- [openapi](./docs/api/openapi.yaml)

- [DB](./docs/db/README.md)

## Developing

Java21 をインストールしてください。

以下のコマンドで開発サーバーを起動します。

```sh

./gradlew bootRun

```

### dependency の追加

dependency locking しています。新しく依存関係を追加する際は、以下のコマンドを実行してください。

```sh

./gradlew dependencies --write-locks

```