Comments (4)
Yes, It has the ability. But for the business development, it require more complete generation capability. Like GraphQL playground or another form.
from farrow.
It will be easy use implement a documentation generator via the introspection of farrow-api
, render the JSON protocol to a pretty SPA page.
Are you interested in this direction? PR is welcome.
from farrow.
The codegen result of farrow-api
is useful as documentation
class MyApiInput extends ObjectType {
name = {
description: 'the text in here will be convert to a comment for api consumer',
deprecated: 'deprecated info',
[Type]: String
}
It may be also useful to render the info to a web page.
from farrow.
Best practices for API version management are also needed.
from farrow.
Related Issues (20)
- [bug?] api match HOT 9
- [disscussion] why not use zod? HOT 2
- [bug] did not change any but http.serve just not woking in windows now HOT 3
- Bug: The farrow-next-react template project crashes when executing dev HOT 2
- Optimize Request: Response message from farrow-api
- Feature Request(farrow-client-api): custom fetcher HOT 7
- Feature Request(farrow): createFarrowConfig or defineConfig HOT 2
- code typo? HOT 3
- Feature Request: refactor farrow with commander HOT 1
- [email protected] 版本 dist 内容不正确 HOT 6
- Feature request: 提供 ES5 产物 HOT 4
- Feature Request(farrow-api-server): optional introspection HOT 1
- Feature Request(farrow-api-server): add /playground route HOT 1
- Feature Request(farrow-schema): Need a Bottom Type like never HOT 5
- Bug(farrow-schema): Literal validation in non-strict mode
- Adjustment Request: the code of code generation for client should be in farrow-api-client not the farrow-api HOT 3
- Question: 没有使用 schema 格式定义的 url 时解析不出 param 和 query,这是预期的行为吗? HOT 4
- Question: 使用 type 定义的类型作为 json 参数时 ts 没问题,但是同样的定义用 interface 就报错了 HOT 4
- Feature: farrow-schema 序列化反序列化,性能测试&优化 HOT 1
- README 阅读体验不好 HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from farrow.