swagger-api / swagger-api/swagger-ui
Issue with swagger-ui (3.24.0) angular (8.2.0) integration
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 29k
- Forks
- 9.3k
- Avg merge
- 2d 23h
- Merged PRs (30d)
- 25
Description
Q&A (please complete the following information)
- OS: Windows
- Browser: Chrome
- Version: Version 77.0.3865.120 (Official Build) (32-bit)
- Method of installation: npm
- Swagger-UI version: 3.24.0
- Swagger/OpenAPI version: 8.2.0
###Example Swagger/OpenAPI definition:
###Swagger-UI configuration options:
Followed this link - https://github.com/agoncal/swagger-ui-angular6
Describe the bug you're encountering
_stream_writable.js:57 Uncaught ReferenceError: process is not defined at Object../node_modules/readable-stream/lib/_stream_writable.js (_stream_writable.js:57) at webpack_require (bootstrap:79) at Object../node_modules/readable-stream/readable-browser.js (readable-browser.js:4) at webpack_require (bootstrap:79) at Object../node_modules/stream-browserify/index.js (index.js:28) at webpack_require (bootstrap:79) at Object. (swagger-ui.js:8) at n (swagger-ui.js:1) at Object. (swagger-ui.js:1) at Object. (swagger-ui.js:1)
I believe this issue is related to Polyfills and related to Angular, SwaggerUI versions incompatibility.
I tried with Angular (7.2.0) and SwaggerUI (3.21.0) and it works perfectly fine.
For your reference, here is the link I followed for SwaggerUI (3.21.0) integrate with Angular (7.2.0) https://github.com/agoncal/swagger-ui-angular6
To reproduce...
Steps to reproduce the behavior:
- Go to '...'
- Click on '....'
- Scroll down to '....'
- See error
Expected behavior
It should show the API supplied in a nice swagger-ui view
Screenshots
Additional context or thoughts
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the npm-installed Angular integration described in the issue, using the referenced agoncal/swagger-ui-angular6 example and the reported browser versions. Trace the failure from node_modules/readable-stream/lib/_stream_writable.js through stream-browserify and swagger-ui.js, then compare with the working Angular 7.2.0 and Swagger UI 3.21.0 setup. Done means the Angular 8.2.0 integration renders the supplied API without the process reference error.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- angular, javascript
- Domain
- frontend, web-dev
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100