如何使用swagger记录API?

问题描述

我对如何记录API(aws网关+ lambda)以及如何验证用户输入有疑问。我想我可以以某种方式使用json模式。我的理想情况是这样的:在我的代码中,在API的核心中,我有一个问题实例类。由此,我想创建一个json模式,该模式指定类中字段的名称和字段的类型。我正在寻找灵活性,以指定要在json模式中包括的此问题实例类中的哪些字段。我已经测试过此代码,但是它包含所有字段。是指定包含注释的一种方法,例如带有注释?

SchemaGeneratorConfigBuilder configBuilder = new SchemaGeneratorConfigBuilder(SchemaVersion.DRAFT_2019_09,OptionPreset.PLAIN_JSON);
SchemaGeneratorConfig config = configBuilder.build();
SchemaGenerator generator = new SchemaGenerator(config);
JsonNode jsonSchema = generator.generateSchema(ProblemInstance.class);

我也确实想使用此架构来发布到醒目的UI(例如本示例:https://editor.swagger.io/)。所以我想我需要找到一种方法来将我创建的json模式文件转换为类似于示例中的yaml文件。谁能指导我正确的方向?

解决方法

暂无找到可以解决该程序问题的有效方法,小编努力寻找整理中!

如果你已经找到好的解决方法,欢迎将解决方案带上本链接一起发送给小编。

小编邮箱:dio#foxmail.com (将#修改为@)