项目介绍
概述
Generator是一个基于AsyncAPI规范文件的工具,它能够帮助用户生成所需要的内容。该工具由AsyncAPI组织官方支持,并提供大量现成的模板供用户使用。通过这些模板,用户可以针对不同的开发需求,快速生成相应的代码或文档格式。
官方生成器模板列表
Generator提供多种官方支持的生成器模板,以下是一些主要的模板及其功能说明:
@asyncapi/nodejs-template
:生成使用Hermes包的Node.js服务。@asyncapi/nodejs-ws-template
:生成支持WebSockets协议的Node.js服务。@asyncapi/java-template
:生成Java JMS应用。@asyncapi/java-spring-template
:生成Java Spring服务。@asyncapi/java-spring-cloud-stream-template
:生成Java Spring Cloud Stream服务。@asyncapi/python-paho-template
:生成使用Paho库的Python服务。@asyncapi/html-template
:生成HTML文档网站。@asyncapi/markdown-template
:生成Markdown格式的文档。@asyncapi/ts-nats-template
:生成TypeScript NATS客户端。@asyncapi/go-watermill-template
:生成使用Watermill的Go客户端。@asyncapi/dotnet-nats-template
:生成使用NATS的.NET C#客户端。@asyncapi/php-template
:生成使用RabbitMQ的PHP客户端。@asyncapi/dotnet-rabbitmq-template
:生成使用RabbitMQ的.NET C#客户端。
这些模板不仅覆盖多种开发语言和框架,还支持多种网络协议和服务需求,能够大幅提升开发者的开发效率。
过滤器
apps/nunjucks-filters
库提供了可跨多个模板复用的生成器过滤器,旨在避免重复工作。专门为Nunjucks模板设计的过滤器默认包含在生成器中,用户无需单独添加依赖。
该库包括自定义过滤器和Lodash支持的过滤器,用户可以查阅官方文档获取所有可用过滤器的列表。
钩子
apps/hooks
库包含可在多个模板中复用的生成器钩子,专为减少重复工作而设计。钩子是生成器在生成过程中特定时刻被调用的函数,开发者可以通过配置启用这些钩子函数,让生成过程更加灵活高效。
钩子可以是匿名函数,也可以赋予特定名称,并且可以设置传入参数或期待返回值。在不添加特定依赖的情况下,这些钩子已集成在生成器中,用户只需在配置中明确启用即可。
贡献
对于希望参与开发和贡献的用户,项目提供了详细的开发指南和贡献指南。用户可以参考开发指南和贡献指南来了解项目的贡献流程和技术要求。
贡献者 ✨
项目的发展离不开这些杰出贡献者的支持:
- Fran Méndez
- Jonas Lagoni
- Lukasz Gornicki
- Travis Reeder
- Semen
- Waleed Ashraf
欢迎各类形式的贡献!项目遵循all-contributors规范,以感谢每一位贡献者的努力和支持。