Можно ли настроить заголовок файла исходного кода, сгенерированный swagger-codegen? - PullRequest
0 голосов
/ 04 мая 2018

Я использую swagger-codegen для создания SDK на основе моего веб-API, и сгенерированные исходные файлы содержат следующий заголовок:

/* 
 * [MY PROJECT NAME]
 *
 * [MY COPYRIGHT]
 *
 * OpenAPI spec version: 1.0.0 - Beta
 * Contact: [MY EMAIL]
 * Generated by: https://github.com/swagger-api/swagger-codegen.git
 */

Можно ли настроить swagger-codegen так, чтобы он не генерировал последние 3 строки заголовка?

1 Ответ

0 голосов
/ 04 мая 2018

Да, это возможно. Выходной формат определяется с помощью шаблонов усов.

Найдите шаблоны для вашего языка здесь:
https://github.com/swagger-api/swagger-codegen/tree/master/modules/swagger-codegen/src/main/resources

Загрузите шаблоны, которые вы хотите изменить, и измените их при необходимости. Затем запустите генератор, используя аргумент -t, чтобы указать путь к вашим пользовательским шаблонам:

java -jar swagger-codegen-cli-2-3-1.jar generate
  -i http://petstore.swagger.io/v2/swagger.json
  -l csharp
  -o PetstoreCSharpClient
  -t path/to/MyTemplates    <------

Любые пользовательские шаблоны, найденные в папке -t, будут использоваться вместо соответствующих стандартных шаблонов. Шаблоны, не найденные в папке -t, по умолчанию соответствуют стандартным шаблонам.

Пример

В случае генератора csharp рассматриваемый заголовок происходит от :

modules/swagger-codegen/src/main/resources/csharp/partial_header.mustache

и есть похожие заголовки в:

modules/swagger-codegen/src/main/resources/csharp/Project.mustache
modules/swagger-codegen/src/main/resources/csharp/TestProject.mustache

Загрузите эти 3 файла, скажем, C:\MyTemplates и удалите из них ненужные строки. Затем запустите генератор с -t C:\MyTemplates, чтобы использовать ваши пользовательские шаблоны без этого заголовка.

...