https://github.com/icemokacat/bruno-viewer

viewer for markdown docs in bru file
https://github.com/icemokacat/bruno-viewer

bruno markdown springboot

Last synced: 14 days ago
JSON representation

viewer for markdown docs in bru file

• Host: GitHub
• URL: https://github.com/icemokacat/bruno-viewer
• Owner: icemokacat
• License: other
• Created: 2024-08-23T03:37:57.000Z (3 months ago)
• Default Branch: release
• Last Pushed: 2024-09-13T04:36:16.000Z (2 months ago)
• Last Synced: 2024-10-10T11:20:26.815Z (about 1 month ago)
• Topics: bruno, markdown, springboot
• Language: Java
• Homepage:
• Size: 127 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# 🦄 Bruno API Client Docs Viewer

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

무료로 사용할 수 있는 [bruno api client](https://www.usebruno.com/) 에서 docs 의 마크다운을 볼 수 있는 프로그램입니다.

[![Report bug][report-bug-shield]][report-bug-url]

# 📑 Table of Contents

- [About the Project](#about-the-project)

  - [Features](#features)

  - [Technologies](#technologies)

- [Getting Started](#getting-started)

  - [Prerequisites](#prerequisites)

  - [Installation](#installation)

  - [Configuration](#configuration)

- [Usage](#usage)

    - [1. Page View 방식 (thymeleaf view lendering)](#1-page-view-방식-thymeleaf-view-lendering)

    - [2. HTTP API 호출 방식](#2-http-api-호출-방식)

    - [3. bru collection 내 디렉토리 및 bru 파일 리스트 확인](#3-bru-collection-내-디렉토리-및-bru-파일-리스트-확인)

- [Acknowledgement](#acknowledgement)

- [License](#license)

# 💡 About the Project

- 브루노 Api Client 에서 제공한는 Docs 만 별도로 관리하기 위해 만들어진 프로젝트입니다.

- 문서만 별도로 관리하면서, Front-end 에서 custom 하게 디자인하여 보기좋게 공유하기 위해 만들었습니다.

- .bru 파일을 읽어서 docs {} 부분의 markdown 을 읽어서 보여줍니다.

## 📐 Features

![Java](https://img.shields.io/badge/java-%23ED8B00.svg?style=for-the-badge&logo=openjdk&logoColor=white)![Spring](https://img.shields.io/badge/spring-%236DB33F.svg?style=for-the-badge&logo=spring&logoColor=white)![Thymeleaf](https://img.shields.io/badge/Thymeleaf-%23005C0F.svg?style=for-the-badge&logo=Thymeleaf&logoColor=white)

## 🔨 Technologies

- [Gradle](https://gradle.org/) 8.8

- [SpringBoot](https://spring.io/projects/spring-boot) 3.3.3

- [Thymeleaf](https://www.thymeleaf.org/) 3.3.3

- [commonmark](https://commonmark.org/) 0.22.0

# ⚡ Getting Started

## Prerequisites

- Java 17.0.10+11-LTS-240

## Installation

Repository 클론

```bash

git clone https://github.com/icemokacat/bruno-viewer.git

```

## Configuration

- `application-dev.yml 을 참고하여 application-local.yml 을 만들어서 사용하세요.`

- Active profiles local 로 설정하여 실행하세요.

```yml

server:

  port: 7001

bruno:

  # .bru 파일이 있는 Collection의 폴더 경로 혹은 Collection 이 모여 있는 루트 path 를 설정하세요

  root-path: C:\work\bruno-project\

```

# Usage

Springboot 실행 or jar build 후 localhost:{port} 실행

bru 파일의 경로가 아래와 같을때

> {root-path}{상대경로}

### 1. Page View 방식 (thymeleaf view lendering)

http://localhost:{port}/page/bruno/{상대경로} 를 호출하여 .bru 내 markdown 을 볼 수 있습니다.

![결과예시화면](https://github.com/user-attachments/assets/945e9364-62a7-4c61-a64f-655897f802f3)

💡 예시로 사용한 md 문서는 아래의 링크입니다.

> https://gist.github.com/azagniotov/a4b16faf0febd12efbc6c3d7370383a6#file-beautiful-rest-api-docs-in-markdown-md

### 2. HTTP API 호출 방식

http://localhost:{port}/api/bruno/{상대경로} 를 호출하면 .bru 내 markdown 을 

html code로 parsing 한 문자열 데이터를 반환 합니다.

![결과예시화면](https://github.com/user-attachments/assets/d1dc0aae-40a0-40c0-886c-38ea071bc6f3)

💡 예시로 사용한 md 문서는 아래의 링크입니다.

> https://gist.github.com/azagniotov/a4b16faf0febd12efbc6c3d7370383a6#file-beautiful-rest-api-docs-in-markdown-md

### 3. bru collection 내 디렉토리 및 bru 파일 리스트 확인

http://localhost:{port}/api/bruno-path

- Method : GET

- Parameter : dir (폴더명)

- Response OK Data

  ```json

  {

    "httpStatus": "OK",

    "message": "OK",

    "data": [

      {

        "isBru": false,

        "directoryPath": "myapp/environments",

        "directoryName": "environments"

      },

      {

        "isBru": true,

        "directoryPath": "myapp/login.bru",

        "directoryName": "login.bru"

      }

    ]

  }

  ```

# 📚 Acknowledgement

- [Markdown to html (commonmark)](https://mvnrepository.com/artifact/org.commonmark/commonmark)

- [Spring으로 markdown view 만들기](https://devocean.sk.com/blog/techBoardDetail.do?ID=163499)

- [Github Markdown CSS](https://github.com/sindresorhus/github-markdown-css) by [sindresorhus](https://github.com/sindresorhus)

# ✨ License

 Apache License 2.0

 라이센스에 대한 정보는 [`LICENSE`](/LICENSE)에 있습니다.

[report-bug-shield]: https://img.shields.io/badge/-%F0%9F%90%9E%20report%20bug-F5A9A9?style=for-the-badge

[report-bug-url]: https://github.com/icemokacat/bruno-viewer/issues