validate OpenAPI Specification Document
Hi Team, I got the Open API Specificatipon (.yaml) file from my de team,I would like to validate the Definition file against certain guide lines/styles/ruleset.... Could you please let me kno...
Forum Discussion
Thank you for all your responses.
Wellformed checks (something like valid document format etx)can be done when you load the Spec file in the tools.(Ready API etc...)
Let us consider the beow Checks
1. Contact details shpuld have emai and phone number
2.should contains title and descriptions
3.Servers shoud not contain "\" at the end
4.Methods should be snake_case.....
etc..some thing like this....Before Dev team develops the APIs,as part of Testing team you need to ensure that they follow these guide lines while desining the Spec files...
I can actually use SwaggerCompliance assertion to veryfy the Responses are appropriate as per the Spec file...but this is after the Actual API Development is done...
Just looking for some thing in ready API to check the Spec files.(Something similar to the Spectral CLI or OVAL or Speccy)
Anyways I dont see I can do this with Ready API.....I will can continue doing with spectral and ensure the Spac file is true..
Our goal is to ensure the Spc file is single source of truth for Dev,QA or any other teams...
Hi venkireddy1991 ,
I appreciate this doesnt help with your problem...as you already state ReadyAPI! performs a wellformed check when you load in a file and each time the file is parsed, but i just wanted to mention the detail below as this might steer you in another direction.
The checks you mention in your last appear to a mix of what id consider as 'validation' along with a single 'wellformed' check.
I appreciate you want to ensure the developers code adheres to the rules defined in your openAPI .yaml, but whether this is actually necessary or not depends on how the developers are creating the apis themselves.
What i mean by this is there are tools out there that support the creation and update of the openAPI (.yaml) files. What i mean is there are tools such as Smartbears Swagger that allow the user to create your .yaml file and this .yaml file is then used by developers to create the code for the apis themselves (at least i think this is the way it works), so the .yaml is a framework and the apis defined in the .yaml can be generated dynamically from the .yaml. if this is the case (and i think it is from the reading i've just done) then checking the developed apis conform to the rules in the .yaml is moot because the .yaml was used to generate the apis themselves.
I hope ive been clear
Cheers
Rich
I appreciate this doesnt help with your problem...as you already state ReadyAPI! performs a wellformed check when you load in a file and each time the file is parsed, but i just wanted to mention the detail below as this might steer you in another direction.
The checks you mention in your last appear to a mix of what id consider as 'validation' along with a single 'wellformed' check.
I appreciate you want to ensure the developers code adheres to the rules defined in your openAPI .yaml, but whether this is actually necessary or not depends on how the developers are creating the apis themselves.
What i mean by this is there are tools out there that support the creation and update of the openAPI (.yaml) files. What i mean is there are tools such as Smartbears Swagger that allow the user to create your .yaml file and this .yaml file is then used by developers to create the code for the apis themselves (at least i think this is the way it works), so the .yaml is a framework and the apis defined in the .yaml can be generated dynamically from the .yaml. if this is the case (and i think it is from the reading i've just done) then checking the developed apis conform to the rules in the .yaml is moot because the .yaml was used to generate the apis themselves.
I hope ive been clear
Cheers
Rich
Team,
How can add swagger compliance assertion using script??
Thanks for your reply....
But Would like to know how to add in Script..using groovy Script...
- Are you creating the ReadyAPI project automatically? Or using the tool? If project is crated using the tool then it is rather simple to create the desired assertion by hand as it is one time job.
Creating automatic assertion would make sense when project itself is created automatically.
What's your case?Thank you for helping everyone!
venkireddy1991 Please share more details about your use case as nmrao is asking and the Community will try to help you🙂
