You are here

Home » API reference » Swagger UI Field Formatter 7.2

README.txt in Swagger UI Field Formatter 7.2

Same filename and directory in other branches
  1. 8 README.txt
  2. 7 README.txt
Swagger UI Field Formatter
==========================

Introduction
============

* This module provides a field formatter for file fields with allowed file types
  as json or yml, which renders the uploaded json or yml file using the Swagger UI
  if the uploaded json or yml file is a valid swagger file. This module uses the
  Swagger UI Library available at https://github.com/swagger-api/swagger-ui/releases

Requirements
============

* Swagger UI Library https://github.com/swagger-api/swagger-ui/releases

* to be able to allow json or yml file extensions in Drupal, you might need to
  install the file entity module.

Installation
============

* Download the latest Swagger UI library from
  https://github.com/swagger-api/swagger-ui/releases

  Extract the content and place it inside the following directory:
  sites/all/libraries/swagger_ui

  Note: only the content of swagger_ui/dist folder and the swagger_ui/package.json
  file are required by this module. Files with .html extension in swagger_ui/dist/
  folder are unnecessary so they can be removed.

* Download the Swagger UI Field Formatter module from https://drupal.org and extract
  it into your sites/all/modules/contrib. Login as administrator and got admin/modules
  and select Swagger UI Field Formatter and Save the configuration.

Configuration
=============

* Go to admin/structure/types/manage/<type>/fields and add a new field of type file
  and select the widget as file.
  In the allowed extensions field in the field settings add yml,json.
  After saving the new field settings Goto admin/structure/types/manage/<type>/display
  select Swagger UI Formatter from the Format drop down for the newly created file
  field.

* Create a new content of the type <type> to which we added the new file field above
  and upload a valid swagger .yml or .json file.
  You can see that the uploaded swagger file is rendered using the Swagger UI.

File

README.txt
View source 
  1. Swagger UI Field Formatter

  2. ==========================

  3. 

  4. Introduction

  5. ============

  6. 

  7. * This module provides a field formatter for file fields with allowed file types

  8.   as json or yml, which renders the uploaded json or yml file using the Swagger UI

  9.   if the uploaded json or yml file is a valid swagger file. This module uses the

  10.   Swagger UI Library available at https://github.com/swagger-api/swagger-ui/releases

  11. 

  12. Requirements

  13. ============

  14. 

  15. * Swagger UI Library https://github.com/swagger-api/swagger-ui/releases

  16. 

  17. * to be able to allow json or yml file extensions in Drupal, you might need to

  18.   install the file entity module.

  19. 

  20. Installation

  21. ============

  22. 

  23. * Download the latest Swagger UI library from

  24.   https://github.com/swagger-api/swagger-ui/releases

  25. 

  26.   Extract the content and place it inside the following directory:

  27.   sites/all/libraries/swagger_ui

  28. 

  29.   Note: only the content of swagger_ui/dist folder and the swagger_ui/package.json

  30.   file are required by this module. Files with .html extension in swagger_ui/dist/

  31.   folder are unnecessary so they can be removed.

  32. 

  33. * Download the Swagger UI Field Formatter module from https://drupal.org and extract

  34.   it into your sites/all/modules/contrib. Login as administrator and got admin/modules

  35.   and select Swagger UI Field Formatter and Save the configuration.

  36. 

  37. Configuration

  38. =============

  39. 

  40. * Go to admin/structure/types/manage//fields and add a new field of type file

  41.   and select the widget as file.

  42.   In the allowed extensions field in the field settings add yml,json.

  43.   After saving the new field settings Goto admin/structure/types/manage//display

  44.   select Swagger UI Formatter from the Format drop down for the newly created file

  45.   field.

  46. 

  47. * Create a new content of the type  to which we added the new file field above

  48.   and upload a valid swagger .yml or .json file.

  49.   You can see that the uploaded swagger file is rendered using the Swagger UI.