🦄 Bruno API Client Docs Viewer

무료로 사용할 수 있는 bruno api client 에서 docs 의 마크다운을 볼 수 있는 프로그램입니다.

📑 Table of Contents

• About the Project
  • Features
  • Technologies
• Getting Started
  • Prerequisites
  • Installation
  • Configuration
• Usage
  • 1. Page View 방식 (thymeleaf view lendering)
  • 2. HTTP API 호출 방식
  • 3. bru collection 내 디렉토리 및 bru 파일 리스트 확인
• Acknowledgement
• License

💡 About the Project

• 브루노 Api Client 에서 제공한는 Docs 만 별도로 관리하기 위해 만들어진 프로젝트입니다.
• 문서만 별도로 관리하면서, Front-end 에서 custom 하게 디자인하여 보기좋게 공유하기 위해 만들었습니다.
• .bru 파일을 읽어서 docs {} 부분의 markdown 을 읽어서 보여줍니다.

📐 Features

🔨 Technologies

• Gradle 8.8
• SpringBoot 3.3.3
• Thymeleaf 3.3.3
• commonmark 0.22.0

⚡ Getting Started

Prerequisites

• Java 17.0.10+11-LTS-240

Installation

Repository 클론

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

Configuration

• application-dev.yml 을 참고하여 application-local.yml 을 만들어서 사용하세요.
• Active profiles local 로 설정하여 실행하세요.

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 을 볼 수 있습니다.

💡 예시로 사용한 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 한 문자열 데이터를 반환 합니다.

💡 예시로 사용한 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

  {
    "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)
• Spring으로 markdown view 만들기
• Github Markdown CSS by sindresorhus

✨ License

Apache License 2.0

라이센스에 대한 정보는 LICENSE에 있습니다.