{ Community }
  • Academy
  • Docs
  • Developers
  • Resources
    • Community Articles
    • Apigee on GitHub
    • Code Samples
    • Videos & eBooks
    • Accelerator Methodology
  • Support
  • Ask a Question
  • Spaces
    • Product Announcements
    • General
    • Edge/API Management
    • Developer Portal (Drupal-based)
    • Developer Portal (Integrated)
    • API Design
    • APIM on Istio
    • Extensions
    • Business of APIs
    • Academy/Certification
    • Adapter for Envoy
    • Analytics
    • Events
    • Hybrid
    • Integration (AWS, PCF, Etc.)
    • Microgateway
    • Monetization
    • Private Cloud Deployment
    • 日本語コミュニティ
    • Insights
    • IoT Apigee Link
    • BaaS/Usergrid
    • BaaS Transition/Migration
    • Apigee-127
    • New Customers
    • Topics
    • Questions
    • Articles
    • Ideas
    • Articles
    • Ideas
    • Leaderboard
    • Badges
  • Log in
  • Sign up

Get answers, ideas, and support from the Apigee Community

  • Home /
  • Developer Portal (Drupal-based) /
avatar image
1
Question by santosh_ghalsasi · Apr 05, 2017 at 10:52 AM · 7k Views Portals - DrupalxmlOpenAPI - Swaggerspecspecificationschema

Can we add XML schema definitions to swagger spec

Hi,

Edge API proxies support XML payloads in requests and responses. I wanted to know if there is a provision to give XML schema for these types of payloads in the swagger spec that we create for such API proxies. I know that we can do it for JSON but have not come across any spec that has XML schema mentioned in the definitions and that can help a developer to understand the request and response schema. Any help here will be really appreciated.

Thanks,

Santosh

Comment
Add comment
10 |5000 characters needed characters left characters exceeded
▼
  • Viewable by all users
  • Viewable by Apigeeks only
  • Viewable by the original poster
  • Viewable by moderators
  • Viewable by moderators and the original poster
  • Advanced visibility
Viewable by all users

Close

1 Answer

  • Sort: 
avatar image
0
Best Answer

Answer by Anil Sagar @ Google   · Apr 05, 2017 at 12:58 PM

@santosh_ghalsasi Great Question !

Yes, You can do that. You can add xml schema definitions to OpenAPI (Swagger) Spec. See sample spec here, https://api.myjson.com/bins/10k6cr

See it in action using swagger UI here, http://petstore.swagger.io/

Find spec details here in OpenAPI spec documentation in github. It also has few examples.

Just FYI, I don't think Apigee Smartdocs supports XML sample request / response rendering as of today.


screen-shot-2017-04-05-at-62612-pm.png (199.9 kB)
Comment
Add comment Show 4 · Link
10 |5000 characters needed characters left characters exceeded
▼
  • Viewable by all users
  • Viewable by Apigeeks only
  • Viewable by the original poster
  • Viewable by moderators
  • Viewable by moderators and the original poster
  • Advanced visibility
Viewable by all users
avatar image santosh_ghalsasi   · Apr 06, 2017 at 01:41 PM 0
Link

Hi @Anil Sagar (asagar@apigee.com),

Thank you for your help. By the line - "I don't think Apigee Smartdocs supports XML sample request / response rendering as of today." do you mean that the smart docs in dev portal will not be able to accommodate the spec that contains xmlObject in schema definition?

Regards,

Santosh

avatar image santosh_ghalsasi santosh_ghalsasi   · Apr 24, 2017 at 09:45 AM 0
Link

Hi @Anil Sagar ,

Can you please help and clarify above doubt about support for this by smartdocs.

Thanks,

Santosh

avatar image Anil Sagar @ Google ♦♦ santosh_ghalsasi   · Apr 26, 2017 at 11:42 PM 0
Link

@santosh_ghalsasi , It does work, but you will not see sample request schema as far as i know. API interaction should work. Hope it helps.

Show more comments

Follow this Question

Answers Answers and Comments

49 People are following this question.

avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image

Related Questions

How to download OpenAPI Specification from Developer Portal 2 Answers

Portal not calling the API proxy 1 Answer

SmartDocs access to original imported OpenAPI / Swagger spec 0 Answers

Documenting real time messaging APIs in Edge 1 Answer

Display raw swagger file on Smartdocs sandbox testing page in a tab 0 Answers

  • Products
    • Edge - APIs
    • Insights - Big Data
    • Plans
  • Developers
    • Overview
    • Documentation
  • Resources
    • Overview
    • Blog
    • Apigee Institute
    • Academy
    • Documentation
  • Company
    • Overview
    • Press
    • Customers
    • Partners
    • Team
    • Events
    • Careers
    • Contact Us
  • Support
    • Support Overview
    • Documentation
    • Status
    • Edge Support Portal
    • Privacy Policy
    • Terms & Conditions
© 2021 Apigee Corp. All rights reserved. - Apigee Community Terms of Use - Powered by AnswerHub
  • Anonymous
  • Sign in
  • Create
  • Ask a question
  • Create an article
  • Post an idea
  • Create an article
  • Post an idea
  • Spaces
  • Product Announcements
  • General
  • Edge/API Management
  • Developer Portal (Drupal-based)
  • Developer Portal (Integrated)
  • API Design
  • APIM on Istio
  • Extensions
  • Business of APIs
  • Academy/Certification
  • Adapter for Envoy
  • Analytics
  • Events
  • Hybrid
  • Integration (AWS, PCF, Etc.)
  • Microgateway
  • Monetization
  • Private Cloud Deployment
  • 日本語コミュニティ
  • Insights
  • IoT Apigee Link
  • BaaS/Usergrid
  • BaaS Transition/Migration
  • Apigee-127
  • New Customers
  • Explore
  • Topics
  • Questions
  • Articles
  • Ideas
  • Articles
  • Ideas
  • Badges