provision made to add Xml namespace in swagger from Data Contract att…#218
Open
kapiljxanthus wants to merge 1 commit intoabelsilva:masterfrom
Open
provision made to add Xml namespace in swagger from Data Contract att…#218kapiljxanthus wants to merge 1 commit intoabelsilva:masterfrom
kapiljxanthus wants to merge 1 commit intoabelsilva:masterfrom
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem:
In scenarios where API Request object in HTTP body needs to have a namespace defined in its data contract ,
the swagger example does not have the namespace included as an attribute, So we need to manually add the namespace every time to make an actual request.
Solution:
For the definition types in swagger json generated,
We can add the xml root property with namespace sub property.
This namespace will be read from the DataContract attribute Namespace property in C#
In swagger UI, the example for API will now include the namespace like below which also gets copied on click, so no need to edit the namespace manually.
Testing: I verified the ouput in swagger UI after making the changes done above.