Блог

Главная - Вопросы по программированию - Сгенерировать RAML-файл для существующего API в Java

Сгенерировать RAML-файл для существующего API в Java

#java #rest #mulesoft #raml

#java #rest #mulesoft #raml

Вопрос:

Я новичок в RAML, и я ищу инструмент или любой способ, с помощью которого я могу создать файл RAML, передав несколько деталей. Это займет много времени, если я попытаюсь вручную написать файлы RAML для существующего API.

Ниже приведен желаемый формат файла RAML.

 %RAML 1.0
baseUri: https://api.test.com/abc
title: Test
version: v1

traits:
     id-required:
      headers:
       id:
        type: string
       secret:
        type: string

/test/:
  description:Test  API
  post:
    is: [id-required]
    description: Test  
    body: 
      application/json:
        example: !include examples/TestRequest.json
        type: !include schemas/TestRequestSchema.json
    responses: 
      200:
        body:
          application/json:
            example: !include examples/TestResponse.json
            type: !include schemas/TestResponseSchema.json
      400:
        body: 
          application/json:
            example: !include examples/TestErrorResponse.json
            type: !include schemas/TestResponseSchema.json

Спасибо,
Рачана

Комментарии:

1. Извините, вопрос не ясен. Зачем вы хотите создать RAML, если он у вас уже есть? Пожалуйста, сосредоточьте вопрос на том, чего вы пытаетесь достичь. Например, для чего вам нужен RAML?

Ответ №1:

Вы можете использовать DocDog. Оттуда он создает RAML из существующего исходного кода. Если это SpringBoot, вы можете легко запустить его с -lang=spring помощью. Если это обычная JAVA, вы можете добавлять комментарии к своему коду (см. readme.md или примеры), чтобы DogDoc мог понять.

Может быть, это поможет вам: https://github.com/skalski/docdog