API-Portal
API-Portal copied to clipboard
Add support for YAML format of OpenAPI specification
When I add a YAML file to the api-specs
folder and then run npm run publish
it results in an error.
Sample OpenAPI file:
openapi: 3.0.0
info:
title: Simple test
version: '1.0'
paths:
/test:
get:
responses:
'204':
description: No response
Error:
Error: Unable to complete publishing. Error: Unable to complete OpenAPI specifications publishing. SyntaxError: Unexpected token o in JSON at position 0 at JSON.parse (
) at OpenApiPublisher.eval (webpack://publisher/./src/publishing/openApiPublisher.ts?:29:46) at Generator.next ( ) at fulfilled (webpack://publisher/./src/publishing/openApiPublisher.ts?:5:58) at OpenApiPublisher.eval (webpack://publisher/./src/publishing/openApiPublisher.ts?:39:23) at Generator.next ( ) at fulfilled (webpack://publisher/./src/publishing/openApiPublisher.ts?:5:58) at SitePublisher.eval (webpack://publisher/./node_modules/@paperbits/core/publishing/sitePublisher.ts?:40:23) at Generator.throw ( ) at rejected (webpack://publisher/./node_modules/@paperbits/core/publishing/sitePublisher.ts?:6:65)
It seems to be trying to parse the YAML file as JSON.
Hi @ChristopherL-STCU, why would you add YAML file to specs folder? Can you please tell what are you trying to achieve?
Sorry, I didn't realize you're talking about YAML format of spec. This format is not supported yet.
Yes, that's it. Okay, thank you.