{ Community }
  • Academy
  • Docs
  • Developers
  • Resources
    • Community Articles
    • Apigee on GitHub
    • Code Samples
    • Videos & eBooks
    • Accelerator Methodology
  • Support
  • Ask a Question
  • Spaces
    • General
    • Edge/API Management
    • Developer Portal
    • API Design
    • APIM on Istio
    • Extensions
    • Business of APIs
    • Academy/Certification
    • Analytics
    • Events
    • 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
    • Leaderboard
    • Badges
  • Log in
  • Sign up

Get answers, ideas, and support from the Apigee Community

  • Home /
  • Apigee-127 /
avatar image
1
Question by Pavan Kulkarni · Sep 25, 2014 at 07:57 AM · 1.3k Views node.jsapigee-127

How do I see Swagger UI of an Apigee 127 project?

I created a hello-world project using Apigee-127. I also understand there is a swagger spec file of the API under api/swagger/swagger.yaml

I'm just not able to find the path to Swagger UI for the /hello API configured.

How can I access this Swagger UI? Is this possible?

Sample swagger UI: http://petstore.swagger.wordnik.com/

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

3 Answers

· Add your answer
  • Sort: 
avatar image
3
Best Answer

Answer by Jeremy Whitlock · Sep 25, 2014 at 04:23 PM

Are you wanting to view the Swagger UI and editor? If so, @Michael Malloy has the correct answer. If you're wanting your API to ship with endpoints that serve your Swagger document (swagger.yaml) and Swagger UI, that's a feature we are currently working on.

Comment
Add comment Show 7 · 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 Marc Calder · Sep 25, 2014 at 06:44 PM 1
Link

Can you give us an indication on when this feature will be available?

I'm trying to get my organization away from RAML and onto Swagger because of the better tooling (a127 = nectar!). It's very hard, however, to do model-driven development when the only guy who can see the model - which in this case is a rendered version of swagger.yaml - is the guy that wrote it.

I can currently achieve model-driven api development using the Mulesoft toolset but like I said, I like a127 better.

Please tell me this feature is imminent...

avatar image jwest1 ♦ Marc Calder · Sep 25, 2014 at 07:05 PM 1
Link

We are actively working on it and want this feature too! In the meantime, if this is an option, you can use a link such as the following:

http://editor.swagger.wordnik.com/?import=https://raw.githubusercontent.com/apigee-127/a127-samples/master/weather-advanced/api/swagger/swagger.yaml

This enables you to share the Swagger spec with nice formatting and docs right now. This is not the final approach, however, just something to bridge the gap.

avatar image Jeremy Whitlock ♦ Marc Calder · Sep 26, 2014 at 04:15 AM 0
Link

The dependency library that provides this feature for a127 has been updated with this feature and has been pushed to NPM. Getting a127 updated to use this feature and expose it should not take much longer, although I cannot give you an exact timeline. As Jeff said, we're actively working on it and cannot wait to deliver this.

avatar image Pavan Kulkarni · Sep 25, 2014 at 11:33 PM 0
Link

Yes, I'm looking for Swagger document which can just serve the Swagger UI, so that API consumers can see and test.

But @Jeremy Whitlock, @jwest1, if I absolutely have to use Swagger UI, can I use the a127 swagger.yaml and serve it externally via a standalone static Swagger UI server?

avatar image Pavan Kulkarni · Sep 26, 2014 at 04:05 AM 0
Link

Oh I just realized, Swagger UI currently doesn't support Swagger Spec 2.0 yet.

https://github.com/wordnik/swagger-ui#compatabilit...

Bummer.

avatar image Jeremy Whitlock ♦ Pavan Kulkarni · Sep 26, 2014 at 04:13 AM 0
Link

Swagger 2.0 support for swagger-ui@master works but it has a few caveats which we will make sure to document. I will not promise a timeline but know that the dependency library that provides this feature for a127 has been updated with this feature and has been pushed to NPM. Getting a127 updated to use this feature and expose it should not take much longer.

avatar image Apostolos Alexiadis · Jan 22, 2015 at 07:49 AM 0
Link

Hello. Is an update for this? i start messing around with apigee127 and created the hello world api. So can I publish a URL for the swagger UI so other developers can see in pretty format my API and have a sandbox too?

avatar image
2

Answer by Michael Malloy   · Sep 25, 2014 at 03:12 PM

To see and edit your swagger spec file, in a terminal cd to the project directory. Then, from the command line enter "a127 project edit". This should open up your swagger document in the browser. Be sure that you do not kill the edit process, or else any changes to your document will not be saved.

Comment
Add comment · 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
0

Answer by cesdaile · May 02, 2015 at 06:57 PM

@Jeremy Whitlock just wondering if the ability to expose the a127 managed swagger.yaml / json meta data is available locally yet through swagger-ui in the latest updates to a127.

Comment
Add comment Show 2 · 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 prabhat ♦ · May 02, 2015 at 07:22 PM 0
Link

If you have latest a127, then underlying swagger.json is available at /swagger which you can now use in swagger-ui.

avatar image cesdaile prabhat ♦ · May 03, 2015 at 02:08 AM 0
Link

how about the /docs and /api-docs endpoints that appear the intention was to host the swagger-ui - seems the middleware is there in node_modules/a127-magic/node_modules/swagger-tools/middleware/2.0 but just not wired up (well at least in the project skeleton i pulled this week)

Your answer

Hint: You can notify a user about this post by typing @username

Up to 5 attachments (including images) can be used with a maximum of 5.0 MB each and 25.0 MB total.

Follow this Question

Answers Answers and Comments

6 People are following this question.

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

Related Questions

Access access token custom attributes in ApiGee 127 Node.js controller file 1 Answer

Script executed prematurely error when trying to call Apigee 127 endpoint 1 Answer

remote analytics not working 3 Answers

Run some function on specific message processor only 1 Answer

Do promises work in Apigee NodeJS 7 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
© 2019 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
  • Spaces
  • General
  • Edge/API Management
  • Developer Portal
  • API Design
  • APIM on Istio
  • Extensions
  • Business of APIs
  • Academy/Certification
  • Analytics
  • Events
  • 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
  • Members
  • Badges