kminami / Apib2swagger
Licence: mit
Convert API Blueprint to Swagger.
Stars: ✭ 148
Programming Languages
javascript
184084 projects - #8 most used programming language
Labels
Projects that are alternatives of or similar to Apib2swagger
Dredd Example
Example application using Dredd and CI
Stars: ✭ 79 (-46.62%)
Mutual labels: swagger, api-blueprint
Dredd
Language-agnostic HTTP API Testing Tool
Stars: ✭ 3,770 (+2447.3%)
Mutual labels: swagger, api-blueprint
Spot
Spot is a concise, developer-friendly way to describe your API contract.
Stars: ✭ 230 (+55.41%)
Mutual labels: swagger, api-blueprint
Apifuzzer
Fuzz test your application using your OpenAPI or Swagger API definition without coding
Stars: ✭ 101 (-31.76%)
Mutual labels: swagger, api-blueprint
Gf Cli
GoFrame Command Line Interface, which is your helpmate for building GoFrame application with convenience.
Stars: ✭ 143 (-3.38%)
Mutual labels: swagger
Swagger Ui Watcher
Automatically refreshes Swagger UI on Swagger file changes
Stars: ✭ 135 (-8.78%)
Mutual labels: swagger
Ruoyi Oracle
(RuoYi)官方仓库 基于SpringBoot的权限管理系统 易读易懂、界面简洁美观。 核心技术采用Spring、MyBatis、Shiro没有任何其它重度依赖。直接运行即可用
Stars: ✭ 134 (-9.46%)
Mutual labels: swagger
Go Micro Boilerplate
The boilerplate of the GoLang application with a clear microservices architecture.
Stars: ✭ 147 (-0.68%)
Mutual labels: swagger
Awesome Documentation Tools
🔥 📚 All the tools, processes and resources you need to create an awesome API & Project documentation
Stars: ✭ 138 (-6.76%)
Mutual labels: swagger
Tropical Fish
Pragmatic 风格的 Java EE 后端开发脚手架,开箱即用。基于 SpringBoot,技术选型采用主流的框架(Mybatis-Plus,Redisson,Xxl-job,Swagger)。项目特点:自定义查询语法, 可以自由组装查询条件查询数据,配合代码生成模块,提高研发效率;自定义 service 方法级别的文档生成规则,在业务方法增加必要的注解,可生成方法调用树,快速把握复杂代码业务逻辑。
Stars: ✭ 142 (-4.05%)
Mutual labels: swagger
Terraform Provider Openapi
OpenAPI Terraform Provider that configures itself at runtime with the resources exposed by the service provider (defined in a swagger file)
Stars: ✭ 134 (-9.46%)
Mutual labels: swagger
Blueman
Convert a generated API Blueprint JSON file into a Postman collection
Stars: ✭ 145 (-2.03%)
Mutual labels: api-blueprint
Mi S
基于SpringBoot+SpringCloud+Mybatis主流框架搭建的分布式敏捷开发系统架构,为中、小型项目打造企业级基础开发多种解决方案。
Stars: ✭ 140 (-5.41%)
Mutual labels: swagger
Swagger to uml
Convert OpenAPI specifications (a.k.a. Swagger) to PlantUML diagrams
Stars: ✭ 144 (-2.7%)
Mutual labels: swagger
Express Oas Generator
OpenAPI (Swagger) specification generator for ExpressJS applications
Stars: ✭ 138 (-6.76%)
Mutual labels: swagger
Gemini
Model Driven REST framework to automatically generate CRUD APIs
Stars: ✭ 138 (-6.76%)
Mutual labels: swagger
apib2swagger
Convert API Blueprint to Swagger.
Supported versions:
- API Blueprint 1A9
-
Metadata section
- HOST -> .host, .basePath, .schemes
- VERSION -> .info.version
- Include directive
-
Metadata section
- Swagger 2.0
- Node.js 10.x, 12.x or higher
Install
$ npm install -g apib2swagger
Usage
Convert to Swagger specification.
$ apib2swagger -i api.md
$ apib2swagger -i api.md -o swagger.json
$ apib2swagger -i api.md --yaml -o swagger.yaml
$ apib2swagger -i api.md --prefer-reference
$ apib2swagger -i api.md --bearer-apikey
Without -i option it reads from STDIN, without -o option writes to STDOUT.
$ apib2swagger < api.md > swagger.json
$ cat api.md | apib2swagger
Run http server with SwaggerUI. SwaggerUI will be automatically downloaded to current dir.
$ apib2swagger -i api.md -s
$ apib2swagger -i api.md -s -p 3000
Use as a library.
var apib2swagger = require('apib2swagger'),
apib = '...',
options = { preferReference: true, bearerAsApikey: false };
apib2swagger.convert(apib, options, function (error, result) {
if (!error) console.log(result.swagger);
});
npx
You can run apib2swagger via npx
(without first needing to install it) like so:
cat api.md | npx apib2swagger > swagger.json
Docker
You can also run apib2swagger inside a docker container.
$ docker run -it --rm -v $(pwd):/docs kminami/apib2swagger -i /docs/api.md -o /docs/swagger.json
You can use container images in GitHub Container Registory like ghcr.io/kminami/apib2swagger
or ghcr.io/kminami/apib2swagger:1.12.0
instead of Docker Hub.
License
Copyright (c) 2015 Keisuke Minami
MIT
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].