You are here

Home » API reference » Swagger UI Field Formatter 8

README.txt in Swagger UI Field Formatter 8

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

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

This module provides a field formatter for file fields with allowed file types
of JSON (.json) and/or YAML (.yml or .yaml), which renders the uploaded file
using Swagger UI if the file is a valid Swagger file. This module uses the
Swagger UI library available at https://github.com/swagger-api/swagger-ui

Requirements
============
This module does not have any special requirements.

Installation
============
Download the module from https://drupal.org and extract it into your
sites/all/modules/contrib directory. Login as administrator, go the the
admin/modules page and install the Swagger UI Field Formatter module.

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

Go to the admin/structure/types/manage/<type>/fields page, add a new field
of type File and add "json", "yml" or "yaml" to allowed file extensions.
Then go the admin/structure/types/manage/<type>/display page and select
Swagger UI from the Format drop down.

Create a new content of the type <type> to which you added the new file field
and upload a valid Swagger file.

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. of JSON (.json) and/or YAML (.yml or .yaml), which renders the uploaded file

  9. using Swagger UI if the file is a valid Swagger file. This module uses the

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

  11. 

  12. Requirements

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

  14. This module does not have any special requirements.

  15. 

  16. Installation

  17. ============

  18. Download the module from https://drupal.org and extract it into your

  19. sites/all/modules/contrib directory. Login as administrator, go the the

  20. admin/modules page and install the Swagger UI Field Formatter module.

  21. 

  22. Configuration

  23. =============

  24. 

  25. Go to the admin/structure/types/manage//fields page, add a new field

  26. of type File and add "json", "yml" or "yaml" to allowed file extensions.

  27. Then go the admin/structure/types/manage//display page and select

  28. Swagger UI from the Format drop down.

  29. 

  30. Create a new content of the type  to which you added the new file field

  31. and upload a valid Swagger file.