GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → Forgus → Api Generator

Forgus / Api Generator

Licence: gpl-2.0
Api Generator是一款可以自动解析Controller类抽取REST接口信息并自动上传YApi的IDEA插件。YApi好伴侣，从此维护文档再也不是事儿了！

Programming Languages

java
68154 projects - #9 most used programming language

Labels

rest-apiresttoolsrestful-apidubboapi-documentationpreferencesidea-plugin

Projects that are alternatives of or similar to Api Generator

Apidoc
RESTful API 文档生成工具，支持 Go、Java、Swift、JavaScript、Rust、PHP、Python、Typescript、Kotlin 和 Ruby 等大部分语言。
Stars: ✭ 785 (+464.75%)
Mutual labels:  rest-api, rest, restful-api, tools
Ngx Restangular
Restangular for Angular 2 and higher versions
Stars: ✭ 787 (+466.19%)
Mutual labels:  rest-api, rest, restful-api
Rest Api Design Guide
NBB's REST-ish API Design Guide
Stars: ✭ 643 (+362.59%)
Mutual labels:  rest-api, rest, restful-api
Generator Http Fake Backend
Yeoman generator for building a fake backend by providing the content of JSON files or JavaScript objects through configurable routes.
Stars: ✭ 49 (-64.75%)
Mutual labels:  rest-api, rest, restful-api
Automatic Api
A list of software that turns your database into a REST/GraphQL API
Stars: ✭ 1,583 (+1038.85%)
Mutual labels:  rest-api, rest, restful-api
Restful Api Design References
RESTful API 设计参考文献列表，可帮助你更加彻底的了解REST风格的接口设计。
Stars: ✭ 4,830 (+3374.82%)
Mutual labels:  rest-api, rest, restful-api
Farwest
Framework for building RESTful HATEOAS-driven applications.
Stars: ✭ 18 (-87.05%)
Mutual labels:  rest-api, rest, restful-api
Http Fake Backend
Build a fake backend by providing the content of JSON files or JavaScript objects through configurable routes.
Stars: ✭ 253 (+82.01%)
Mutual labels:  rest-api, rest, restful-api
Api Strategy
Equinor API Strategy
Stars: ✭ 56 (-59.71%)
Mutual labels:  rest-api, rest, restful-api
Openapi Generator
OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)
Stars: ✭ 10,634 (+7550.36%)
Mutual labels:  rest-api, rest, restful-api
Restfm
RESTful web services for FileMaker server.
Stars: ✭ 76 (-45.32%)
Mutual labels:  rest-api, rest, restful-api
Cerberus
A demonstration of a completely stateless and RESTful token-based authorization system using JSON Web Tokens (JWT) and Spring Security.
Stars: ✭ 482 (+246.76%)
Mutual labels:  rest-api, rest, restful-api
Gramework
Fast and Reliable Golang Web Framework
Stars: ✭ 354 (+154.68%)
Mutual labels:  rest-api, rest, restful-api
Json Server Heroku
Deploy json-server to Heroku & Azure 🆙 🆓
Stars: ✭ 310 (+123.02%)
Mutual labels:  rest-api, rest, restful-api
Sandman2
Automatically generate a RESTful API service for your legacy database. No code required!
Stars: ✭ 1,765 (+1169.78%)
Mutual labels:  rest-api, rest, restful-api
Gen
Converts a database into gorm structs and RESTful api
Stars: ✭ 825 (+493.53%)
Mutual labels:  rest-api, rest, restful-api
Graphql2rest
GraphQL to REST converter: automatically generate a RESTful API from your existing GraphQL API
Stars: ✭ 181 (+30.22%)
Mutual labels:  rest-api, rest, restful-api
Blogbackendproject
Backend code for my blogs, develop with Django Rest framework.
Stars: ✭ 204 (+46.76%)
Mutual labels:  rest-api, rest, restful-api
Calm
It is always Calm before a Tornado!
Stars: ✭ 50 (-64.03%)
Mutual labels:  rest-api, rest, restful-api
Evolutility Server Node
Model-driven REST or GraphQL backend for CRUD and more, written in Javascript, using Node.js, Express, and PostgreSQL.
Stars: ✭ 84 (-39.57%)
Mutual labels:  rest-api, rest, restful-api
View All Similar Projects ➔

Api Generator

简介

《Api Generator》是一款可以自动生成接口文档的IDEA插件。包括基于Spring注解的RESTful接口和用于定义dubbo api的普通接口。其中，RESTful接口将自动上传并托管在内网部署的YApi服务器上，而普通接口则以markdown文件的形式保存在指定目录。 所以，如果你想利用该插件的能力帮你生成REST接口文档，请先确保你已部署好自己的YApi服务端。
传送门：如何部署YApi平台

特性

  • 基于javadoc解析，无代码入侵
  • 支持字段过滤，自动忽略过滤字段的解析
  • 自动识别类，生成markdown文档或上传到YApi
  • 支持List、Set、Collection等数据结构，支持嵌套泛型解析
  • 支持@NotNull、@ResponseBody等常用注解的解析，基于json5生成YApi文档

快速开始

安装插件

Preferences → Plugins → Marketplace → 搜索“Api Generator” → 安装该插件 → 重启IDE

开始使用

上传REST接口

选择一个Controller类，将光标定位到方法区（方法名或者方法注释）或Controller类上，点击鼠标右键，在弹出的菜单项里选择“Generate Api”单击，文档瞬间已经自动生成并托管到YApi平台！
（PS：首次使用会弹框提示输入YApi部署的url和项目token，填写一次自动保存）

生成dubbo接口文档

操作方式同上，插件会自动识别出这是一个普通接口，插件会将文档以markdown的形式输出，默认保存在当前项目的target目录下。（保存路径可更改，见下文介绍）

插件设置

自定义配置项： Preferences —> Other Settings —> Api Generator Setting
配置项|含义|详细解释 ---|---|--- Exclude Fields|过滤字段（多个字段以","分隔）|该配置项功能类似JSONField，用于过滤不想被解析的字段，多用于排除二方包里的干扰字段 Save Directory|markdown文档保存目录（绝对路径）|用于配置生成的markdown形式的接口文档的保存路径，默认保存在当前项目的target目录 Indent Style|二级字段缩进前缀|生成的markdown文档是类似于json schema的字段表格，涉及类型是对象的字段，展示上做缩进处理，默认缩进前缀是“└” Overwrite exists docs|是否覆盖同名markdown文档|如果生成的markdown文件已存在，会弹框提示是否覆盖，勾选该选项，则直接覆盖不提示 Extract filename from doc comments|是否从javadoc抽取文件名|生成的markdown文件默认是方法名，勾选该选项，将从注释里抽取文件名 YApi server url|YApi部署服务器地址|内网部署的yapi平台的域名，如：http://yapi.xxx.com Project token|项目token|接口对应的yapi项目的token Default save category|默认保存分类|插件生成的yapi文档保存位置，默认api_generator Classify API automatically|是否自动分类|勾选该选项后，生成文档时插件将从controller类注释里抽取模块名，并在yapi上自动创建对应分类保存接口

详细文档

更多详细介绍请移步wiki
PS：如果觉得好用，请帮我点个赞~

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].